SGI Freeware 1999 August/SGI Freeware 1999 August.iso/dist/fw_xemacs.idb/usr/freeware/lib/xemacs-20.4/lisp/custom/wid-edit.el.z/wid-edit.el

Text File | 1998-05-21 | 120.2 KB | 3,653 lines

;;; wid-edit.el --- Functions for creating and using widgets.
;;
;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
;;
;; Author: Per Abrahamsen <[e-mail]>
;; Maintainer: Hrvoje Niksic <[e-mail]>
;; Keywords: extensions
;; Version: 1.9960-x
;; X-URL: http://www.dina.kvl.dk/~abraham/custom/

;; This file is part of XEmacs.

;; XEmacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; XEmacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with XEmacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:
;;
;; See `widget.el'.


;;; Code:

(require 'widget)

(autoload 'pp-to-string "pp")
(autoload 'finder-commentary "finder" nil t)

;;; Customization.

(defgroup widgets nil
  "Customization support for the Widget Library."
  :link '(custom-manual "(widget)Top")
  :link '(url-link :tag "Development Page"
           "http://www.dina.kvl.dk/~abraham/custom/")
  :link '(emacs-library-link :tag "Lisp File" "widget.el")
  :prefix "widget-"
  :group 'extensions
  :group 'hypermedia)

(defgroup widget-documentation nil
  "Options controling the display of documentation strings."
  :group 'widgets)

(defgroup widget-faces nil
  "Faces used by the widget library."
  :group 'widgets
  :group 'faces)

(defvar widget-documentation-face 'widget-documentation-face
  "Face used for documentation strings in widges.
This exists as a variable so it can be set locally in certain buffers.")

(defface widget-documentation-face '((((class color)
                       (background dark))
                      (:foreground "lime green"))
                     (((class color)
                       (background light))
                      (:foreground "dark green"))
                     (t nil))
  "Face used for documentation text."
  :group 'widget-documentation
  :group 'widget-faces)

(defvar widget-button-face 'widget-button-face
  "Face used for buttons in widges.
This exists as a variable so it can be set locally in certain buffers.")

(defface widget-button-face '((t (:bold t)))
  "Face used for widget buttons."
  :group 'widget-faces)

(defcustom widget-mouse-face 'highlight
  "Face used for widget buttons when the mouse is above them."
  :type 'face
  :group 'widget-faces)

(defface widget-field-face '((((class grayscale color)
                   (background light))
                  (:background "gray85"))
                 (((class grayscale color)
                   (background dark))
                  (:background "dim gray"))
                 (t
                  (:italic t)))
  "Face used for editable fields."
  :group 'widget-faces)

;; Currently unused
;(defface widget-single-line-field-face '((((class grayscale color)
;                       (background light))
;                      (:background "gray85"))
;                     (((class grayscale color)
;                       (background dark))
;                      (:background "dim gray"))
;                     (t
;                      (:italic t)))
;  "Face used for editable fields spanning only a single line."
;  :group 'widget-faces)
;
;(defvar widget-single-line-display-table
;  (let ((table (make-display-table)))
;    (aset table 9  "^I")
;    (aset table 10 "^J")
;    table)
;  "Display table used for single-line editable fields.")
;
;(set-face-display-table 'widget-single-line-field-face
;            widget-single-line-display-table)


;; Some functions from this file have been ported to C for speed.
;; Setting this to t (*before* loading wid-edit.el) will make them
;; shadow the subrs.  It should be used only for debugging purposes.
(defvar widget-shadow-subrs nil)


;;; Utility functions.
;;
;; These are not really widget specific.

(when (or (not (fboundp 'widget-plist-member))
      widget-shadow-subrs)
  ;; Recoded in C, for efficiency.  It used to be a defsubst, but old
  ;; compiled code won't fail -- it will just be slower.
  (defun widget-plist-member (plist prop)
    ;; Return non-nil if PLIST has the property PROP.
    ;; PLIST is a property list, which is a list of the form
    ;; (PROP1 VALUE1 PROP2 VALUE2 ...).  PROP is a symbol.
    ;; Unlike `plist-get', this allows you to distinguish between a missing
    ;; property and a property with the value nil.
    ;; The value is actually the tail of PLIST whose car is PROP.
    (while (and plist (not (eq (car plist) prop)))
      (setq plist (cddr plist)))
    plist))

(defun widget-princ-to-string (object)
  ;; Return string representation of OBJECT, any Lisp object.
  ;; No quoting characters are used; no delimiters are printed around
  ;; the contents of strings.
  (with-current-buffer (get-buffer-create " *widget-tmp*")
    (erase-buffer)
    (princ object (current-buffer))
    (buffer-string)))

(defun widget-clear-undo ()
  "Clear all undo information."
  (buffer-disable-undo)
  (buffer-enable-undo))

(defcustom widget-menu-max-size 40
  "Largest number of items allowed in a popup-menu.
Larger menus are read through the minibuffer."
  :group 'widgets
  :type 'integer)

(defcustom widget-menu-minibuffer-flag nil
  "*Control how to ask for a choice from the keyboard.
Non-nil means use the minibuffer;
nil means read a single character."
  :group 'widgets
  :type 'boolean)

(defun widget-choose (title items &optional event)
  "Choose an item from a list.

First argument TITLE is the name of the list.
Second argument ITEMS is an list whose members are either
 (NAME . VALUE), to indicate selectable items, or just strings to
 indicate unselectable items.
Optional third argument EVENT is an input event.

The user is asked to choose between each NAME from the items alist,
and the VALUE of the chosen element will be returned.  If EVENT is a
mouse event, and the number of elements in items is less than
`widget-menu-max-size', a popup menu will be used, otherwise the
minibuffer."
  (cond    ((and (< (length items) widget-menu-max-size)
          event
          (console-on-window-system-p))
     ;; Pressed by the mouse.
     (let ((val (get-popup-menu-response
             (cons title
               (mapcar (lambda (x)
                     (if (stringp x)
                     (vector x nil nil)
                       (vector (car x) (list (car x)) t)))
                   items)))))
       (setq val (and val
              (listp (event-object val))
              (stringp (car-safe (event-object val)))
              (car (event-object val))))
       (cdr (assoc val items))))
    ((and (not widget-menu-minibuffer-flag)
          ;; Can't handle more than 10 items (as many digits)
          (<= (length items) 10))
     ;; Construct a menu of the choices
     ;; and then use it for prompting for a single character.
     (let* ((overriding-terminal-local-map (make-sparse-keymap))
        (map (make-sparse-keymap title))
        (next-digit ?0)
        some-choice-enabled value)
       ;; Define SPC as a prefix char to get to this menu.
       (define-key overriding-terminal-local-map " " map)
       (with-current-buffer (get-buffer-create " widget-choose")
         (erase-buffer)
         (insert "Available choices:\n\n")
         (dolist (choice items)
           (when (consp choice)
         (let* ((name (car choice))
            (function (cdr choice)))
           (insert (format "%c = %s\n" next-digit name))
           (define-key map (vector next-digit) function)
           (setq some-choice-enabled t)))
           ;; Allocate digits to disabled alternatives
           ;; so that the digit of a given alternative never varies.
           (incf next-digit))
         (insert "\nC-g = Quit"))
       (or some-choice-enabled
           (error "None of the choices is currently meaningful"))
       (define-key map [?\C-g] 'keyboard-quit)
       (define-key map [t] 'keyboard-quit)
       ;(setcdr map (nreverse (cdr map)))
       ;; Unread a SPC to lead to our new menu.
       (push (character-to-event ?\ ) unread-command-events)
       ;; Read a char with the menu, and return the result
       ;; that corresponds to it.
       (save-window-excursion
         (display-buffer (get-buffer " widget-choose"))
         (let ((cursor-in-echo-area t))
           (setq value
             (lookup-key overriding-terminal-local-map
                 (read-key-sequence (concat title ": ") t)))))
       (message "")
       (when (or (eq value 'keyboard-quit)
             (null value))
         (error "Canceled"))
       value))
    (t
     ;; Read the choice of name from the minibuffer.
     (setq items (remove-if 'stringp items))
     (let ((val (completing-read (concat title ": ") items nil t)))
       (if (stringp val)
           (let ((try (try-completion val items)))
         (when (stringp try)
           (setq val try))
         (cdr (assoc val items)))
         nil)))))


;;; Widget text specifications.
;;
;; These functions are for specifying text properties.

(defcustom widget-field-add-space t
  ;; Setting this to nil might be available, once some problems are resolved.
  "Non-nil means add extra space at the end of editable text fields.

This is needed on all versions of Emacs.  If you don't add the space,
it will become impossible to edit a zero size field."
  :type 'boolean
  :group 'widgets)

(defcustom widget-field-use-before-change
  (and (or (> emacs-minor-version 34)
       (> emacs-major-version 19))
       (not (string-match "XEmacs" emacs-version)))
  "Non-nil means use `before-change-functions' to track editable fields.
This enables the use of undo, but doesn't work on Emacs 19.34 and earlier.
Using before hooks also means that the :notify function can't know the
new value."
  :type 'boolean
  :group 'widgets)

(defun widget-specify-field (widget from to)
  "Specify editable button for WIDGET between FROM and TO."
  (save-excursion
    (goto-char to)
    (cond ((null (widget-get widget :size))
       (forward-char 1))
      ;; Terminating space is not part of the field, but necessary in
      ;; order for local-map to work.  Remove next sexp if local-map works
      ;; at the end of the extent.
      (widget-field-add-space
       (insert-and-inherit " ")))
    (setq to (point)))
  (let ((map (widget-get widget :keymap))
    (face (or (widget-get widget :value-face) 'widget-field-face))
    (help-echo (widget-get widget :help-echo))
    (extent (make-extent from to)))
    (unless (or (stringp help-echo) (null help-echo))
      (setq help-echo 'widget-mouse-help))
    (widget-put widget :field-extent extent)
    (and (or (not widget-field-add-space)
         (widget-get widget :size))
     (set-extent-property extent 'end-closed nil))
    (set-extent-property extent 'detachable nil)
    (set-extent-property extent 'field widget)
    (set-extent-property extent 'button-or-field t)
    (set-extent-property extent 'keymap map)
    (set-extent-property extent 'face face)
    (set-extent-property extent 'balloon-help help-echo)
    (set-extent-property extent 'help-echo help-echo)))

(defun widget-specify-button (widget from to)
  "Specify button for WIDGET between FROM and TO."
  (let ((face (widget-apply widget :button-face-get))
    (help-echo (widget-get widget :help-echo))
    (extent (make-extent from to))
    (map (widget-get widget :button-keymap)))
    (widget-put widget :button-extent extent)
    (unless (or (null help-echo) (stringp help-echo))
      (setq help-echo 'widget-mouse-help))
    (set-extent-property extent 'start-open t)
    (set-extent-property extent 'button widget)
    (set-extent-property extent 'button-or-field t)
    (set-extent-property extent 'mouse-face widget-mouse-face)
    (set-extent-property extent 'balloon-help help-echo)
    (set-extent-property extent 'help-echo help-echo)
    (set-extent-property extent 'face face)
    (set-extent-property extent 'keymap map)))

(defun widget-mouse-help (extent)
  "Find mouse help string for button in extent."
  (let* ((widget (widget-at (extent-start-position extent)))
     (help-echo (and widget (widget-get widget :help-echo))))
    (cond ((stringp help-echo)
       help-echo)
      ((and (functionp help-echo)
        (stringp (setq help-echo (funcall help-echo widget))))
       help-echo)
      (t
       (format "(widget %S :help-echo %S)" widget help-echo)))))

(defun widget-specify-sample (widget from to)
  ;; Specify sample for WIDGET between FROM and TO.
  (let ((face (widget-apply widget :sample-face-get))
    (extent (make-extent from to nil)))
    (set-extent-property extent 'start-open t)
    (set-extent-property extent 'face face)
    (widget-put widget :sample-extent extent)))

(defun widget-specify-doc (widget from to)
  ;; Specify documentation for WIDGET between FROM and TO.
  (let ((extent (make-extent from to)))
    (set-extent-property extent 'start-open t)
    (set-extent-property extent 'widget-doc widget)
    (set-extent-property extent 'face widget-documentation-face)
    (widget-put widget :doc-extent extent)))

(defmacro widget-specify-insert (&rest form)
  ;; Execute FORM without inheriting any text properties.
  `(save-restriction
     (let ((inhibit-read-only t)
       before-change-functions
       after-change-functions)
       (insert "<>")
       (narrow-to-region (- (point) 2) (point))
       (goto-char (1+ (point-min)))
       ;; We use `prog1' instead of a `result' variable, as the latter
       ;; confuses the byte-compiler in some cases (a warning).
       (prog1 (progn ,@form)
     (delete-region (point-min) (1+ (point-min)))
     (delete-region (1- (point-max)) (point-max))
     (goto-char (point-max))))))

(put 'widget-specify-insert 'edebug-form-spec '(&rest form))


;;; Inactive Widgets.

(defface widget-inactive-face '((((class grayscale color)
                  (background dark))
                 (:foreground "light gray"))
                (((class grayscale color)
                  (background light))
                 (:foreground "dim gray"))
                (t
                 (:italic t)))
  "Face used for inactive widgets."
  :group 'widget-faces)

;; For inactiveness to work on complex structures, it is not
;; sufficient to keep track of whether a button/field/glyph is
;; inactive or not -- we must know how many time it was deactivated
;; (inactiveness level).  Successive deactivations of the same button
;; increment its inactive-count, and activations decrement it.  When
;; inactive-count reaches 0, the button/field/glyph is reactivated.

(defun widget-activation-widget-mapper (extent action)
  "Activate or deactivate EXTENT's widget (button or field).
Suitable for use with `map-extents'."
  (ecase action
    (:activate
     (decf (extent-property extent :inactive-count))
     (when (zerop (extent-property extent :inactive-count))
       (set-extent-properties
    extent (extent-property extent :inactive-plist))
       (set-extent-property extent :inactive-plist nil)))
    (:deactivate
     (incf (extent-property extent :inactive-count 0))
     ;; Store a plist of old properties, which will be fed to
     ;; `set-extent-properties'.
     (unless (extent-property extent :inactive-plist)
       (set-extent-property
    extent :inactive-plist
    (list 'mouse-face (extent-property extent 'mouse-face)
          'help-echo (extent-property extent 'help-echo)
          'keymap (extent-property extent 'keymap)))
       (set-extent-properties
    extent '(mouse-face nil help-echo nil keymap nil)))))
  nil)

(defun widget-activation-glyph-mapper (extent action)
  (let ((activate-p (if (eq action :activate) t nil)))
    (if activate-p
    (decf (extent-property extent :inactive-count))
      (incf (extent-property extent :inactive-count 0)))
    (when (or (and activate-p
           (zerop (extent-property extent :inactive-count)))
          (and (not activate-p)
           (not (zerop (extent-property extent :inactive-count)))))
      (let* ((glyph-widget (extent-property extent 'glyph-widget))
         (up-glyph (widget-get glyph-widget :glyph-up))
         (inactive-glyph (widget-get glyph-widget :glyph-inactive))
         (new-glyph (if activate-p up-glyph inactive-glyph)))
     ;; Check that the new glyph exists, and differs from the
     ;; default one.
    (and up-glyph inactive-glyph (not (eq up-glyph inactive-glyph))
         ;; Check if the glyph is already installed.
         (not (eq (extent-end-glyph extent) new-glyph))
         ;; Change it.
         (set-extent-end-glyph extent new-glyph)))))
  nil)

(defun widget-specify-inactive (widget from to)
  "Make WIDGET inactive for user modifications."
  (unless (widget-get widget :inactive)
    (let ((extent (make-extent from to)))
      ;; It is no longer necessary for the extent to be read-only, as
      ;; the inactive editable fields now lose their keymaps.
      (set-extent-properties
       extent '(start-open t face widget-inactive-face
        detachable t priority 2001 widget-inactive t))
      (widget-put widget :inactive extent))
    ;; Deactivate the buttons and fields within the range.  In some
    ;; cases, the fields are not yet setup at the time this function
    ;; is called.  Those fields are deactivated explicitly by
    ;; `widget-setup'.
    (map-extents 'widget-activation-widget-mapper
         nil from to :deactivate nil 'button-or-field)
    ;; Deactivate glyphs.
    (map-extents 'widget-activation-glyph-mapper
         nil from to :deactivate nil 'glyph-widget)))

(defun widget-specify-active (widget)
  "Make WIDGET active for user modifications."
  (let ((inactive (widget-get widget :inactive)))
    (when inactive
      ;; Reactivate the buttons and fields covered by the extent.
      (map-extents 'widget-activation-widget-mapper
           inactive nil nil :activate nil 'button-or-field)
      ;; Reactivate the glyphs.
      (map-extents 'widget-activation-glyph-mapper
           inactive nil nil :activate nil 'end-glyph)
      (delete-extent inactive)
      (widget-put widget :inactive nil))))


;;; Widget Properties.

(defsubst widget-type (widget)
  "Return the type of WIDGET, a symbol."
  (car widget))

(when (or (not (fboundp 'widget-put))
      widget-shadow-subrs)
  (defun widget-put (widget property value)
    "In WIDGET set PROPERTY to VALUE.
The value can later be retrived with `widget-get'."
    (setcdr widget (plist-put (cdr widget) property value))))

;; Recoded in C, for efficiency:
(when (or (not (fboundp 'widget-get))
      widget-shadow-subrs)
  (defun widget-get (widget property)
    "In WIDGET, get the value of PROPERTY.
The value could either be specified when the widget was created, or
later with `widget-put'."
    (let ((missing t)
      value tmp)
      (while missing
    (cond ((setq tmp (widget-plist-member (cdr widget) property))
           (setq value (car (cdr tmp))
             missing nil))
          ((setq tmp (car widget))
           (setq widget (get tmp 'widget-type)))
          (t
           (setq missing nil))))
      value)))

(defun widget-get-indirect (widget property)
  "In WIDGET, get the value of PROPERTY.
If the value is a symbol, return its binding.
Otherwise, just return the value."
  (let ((value (widget-get widget property)))
    (if (symbolp value)
    (symbol-value value)
      value)))

(defun widget-member (widget property)
  "Non-nil iff there is a definition in WIDGET for PROPERTY."
  (cond ((widget-plist-member (cdr widget) property)
     t)
    ((car widget)
     (widget-member (get (car widget) 'widget-type) property))
    (t nil)))

(when (or (not (fboundp 'widget-apply))
      widget-shadow-subrs)
  ;;This is in C, so don't ###utoload
  (defun widget-apply (widget property &rest args)
    "Apply the value of WIDGET's PROPERTY to the widget itself.
ARGS are passed as extra arguments to the function."
    (apply (widget-get widget property) widget args)))

(defun widget-value (widget)
  "Extract the current value of WIDGET."
  (widget-apply widget
        :value-to-external (widget-apply widget :value-get)))

(defun widget-value-set (widget value)
  "Set the current value of WIDGET to VALUE."
  (widget-apply widget
        :value-set (widget-apply widget
                     :value-to-internal value)))

(defun widget-match-inline (widget vals)
  ;; In WIDGET, match the start of VALS.
  (cond ((widget-get widget :inline)
     (widget-apply widget :match-inline vals))
    ((and vals
          (widget-apply widget :match (car vals)))
     (cons (list (car vals)) (cdr vals)))
    (t nil)))

(defun widget-apply-action (widget &optional event)
  "Apply :action in WIDGET in response to EVENT."
  (if (widget-apply widget :active)
      (widget-apply widget :action event)
    (error "Attempt to perform action on inactive widget")))


;;; Helper functions.
;;
;; These are widget specific.

;;;###autoload
(defun widget-prompt-value (widget prompt &optional value unbound)
  "Prompt for a value matching WIDGET, using PROMPT.
The current value is assumed to be VALUE, unless UNBOUND is non-nil."
  (unless (listp widget)
    (setq widget (list widget)))
  (setq prompt (format "[%s] %s" (widget-type widget) prompt))
  (setq widget (widget-convert widget))
  (let ((answer (widget-apply widget :prompt-value prompt value unbound)))
    (unless (widget-apply widget :match answer)
      (error "Value does not match %S type." (car widget)))
    answer))

(defun widget-get-sibling (widget)
  "Get the item WIDGET is assumed to toggle.
This is only meaningful for radio buttons or checkboxes in a list."
  (let* ((parent (widget-get widget :parent))
     (children (widget-get parent :children))
     child)
    (catch 'child
      (while children
    (setq child (car children)
          children (cdr children))
    (when (eq (widget-get child :button) widget)
      (throw 'child child)))
      nil)))

(defun widget-map-buttons (function &optional buffer maparg)
  "Map FUNCTION over the buttons in BUFFER.
FUNCTION is called with the arguments WIDGET and MAPARG.

If FUNCTION returns non-nil, the walk is cancelled.

The arguments MAPARG, and BUFFER default to nil and (current-buffer),
respectively."
  (map-extents (lambda (extent ignore)
         ;; If FUNCTION returns non-nil, we bail out
         (funcall function (extent-property extent 'button) maparg))
           nil nil nil nil nil
           'button))


;;; Glyphs.

(defcustom widget-glyph-directory (locate-data-directory "custom")
  "Where widget glyphs are located.
If this variable is nil, widget will try to locate the directory
automatically."
  :group 'widgets
  :type 'directory)

(defcustom widget-glyph-enable t
  "If non nil, use glyphs in images when available."
  :group 'widgets
  :type 'boolean)

(defcustom widget-image-conversion
  '((xpm ".xpm") (gif ".gif") (png ".png") (jpeg ".jpg" ".jpeg")
    (xbm ".xbm"))
  "Conversion alist from image formats to file name suffixes."
  :group 'widgets
  :type '(repeat (cons :format "%v"
               (symbol :tag "Image Format" unknown)
               (repeat :tag "Suffixes"
                   (string :format "%v")))))

(defvar widget-glyph-cache nil
  "Cache of glyphs associated with strings (files).")

(defun widget-glyph-find (image tag)
  "Create a glyph corresponding to IMAGE with string TAG as fallback.
IMAGE can already be a glyph, or a file name sans extension (xpm,
 xbm, gif, jpg, or png) located in `widget-glyph-directory', or
 in one of the data directories.
It can also be a valid image instantiator, in which case it will be
 used to make the glyph, with an additional TAG string fallback."
  (cond ((not (and image widget-glyph-enable))
     ;; We don't want to use glyphs.
     nil)
    ((and (not (console-on-window-system-p))
          ;; We don't use glyphs on TTY consoles, although we
          ;; could.  However, glyph faces aren't yet working
          ;; properly, and movement through glyphs is unintuitive.
          ;; As an exception, when TAG is nil, we assume that the
          ;; caller knows what he is doing, and that the tag is
          ;; encoded within the glyph.
          (not (glyphp image)))
     nil)
    ((glyphp image)
     ;; Already a glyph.  Use it.
     image)
    ((stringp image)
     ;; A string.  Look it up in the cache first...
     (or (lax-plist-get widget-glyph-cache image)
         ;; ...and then in the relevant directories
         (let* ((dirlist (cons (or widget-glyph-directory
                       (locate-data-directory "custom"))
                   data-directory-list))
            (formats widget-image-conversion)
            file)
           (while (and formats (not file))
         ;; This dance is necessary, because XEmacs signals an
         ;; error when it encounters an unrecognized image
         ;; format.
         (when (valid-image-instantiator-format-p (caar formats))
           (setq file (locate-file image dirlist
                       (mapconcat 'identity (cdar formats)
                              ":"))))
         (unless file
           (pop formats)))
           (when file
         ;; We create a glyph with the file as the default image
         ;; instantiator, and the TAG fallback
         (let ((glyph (make-glyph `([,(caar formats) :file ,file]
                        [string :data ,tag]))))
           ;; Cache the glyph
           (laxputf widget-glyph-cache image glyph)
           ;; ...and return it
           glyph)))))
    ((valid-instantiator-p image 'image)
     ;; A valid image instantiator (e.g. [gif :file "somefile"] etc.)
     (make-glyph `(,image [string :data ,tag])))
    (t
     ;; Oh well.
     nil)))

(defun widget-glyph-insert (widget tag image &optional down inactive)
  "In WIDGET, insert the text TAG or, if supported, IMAGE.
IMAGE should either be a glyph, an image instantiator, an image file
name sans extension (xpm, xbm, gif, jpg, or png) located in
`widget-glyph-directory', or anything else allowed by
`widget-glyph-find'.

If IMAGE is a list, it will be taken as a list of (UP DOWN INACTIVE)
glyphs.  The down and inactive glyphs are shown when glyph is pressed
or inactive, respectively.

The optional DOWN and INACTIVE arguments are deprecated, and exist
only because of compatibility."
  ;; Convert between IMAGE being a list, etc.  Must use `psetq',
  ;; because otherwise change to `image' screws up the rest.
  (psetq image (or (and (consp image)
            (car image))
           image)
     down (or (and (consp image)
               (nth 1 image))
          down)
     inactive (or (and (consp image)
               (nth 2 image))
              inactive))
  (let ((glyph (widget-glyph-find image tag)))
    (if glyph
    (widget-glyph-insert-glyph widget glyph
                   (widget-glyph-find down tag)
                   (widget-glyph-find inactive tag))
      (insert tag))
    glyph))

(defun widget-glyph-insert-glyph (widget glyph &optional down inactive)
  "In WIDGET, insert GLYPH.
If optional arguments DOWN and INACTIVE are given, they should be
glyphs used when the widget is pushed and inactive, respectively."
  (insert "*")
  (let ((extent (make-extent (point) (1- (point))))
    (help-echo (and widget (widget-get widget :help-echo)))
    (map (and widget (widget-get widget :button-keymap))))
    (set-extent-property extent 'glyph-widget widget)
    ;; It would be fun if we could make this extent atomic, so it
    ;; doesn't mess with cursor motion.  But atomic-extents library is
    ;; currently a mess, so I'd rather not use it.
    (set-extent-property extent 'invisible t)
    (set-extent-property extent 'start-open t)
    (set-extent-property extent 'end-open t)
    (set-extent-property extent 'keymap map)
    (set-extent-end-glyph extent glyph)
    (unless (or (stringp help-echo) (null help-echo))
      (setq help-echo 'widget-mouse-help))
    (when help-echo
      (set-extent-property extent 'balloon-help help-echo)
      (set-extent-property extent 'help-echo help-echo)))
  (when widget
    (widget-put widget :glyph-up glyph)
    (when down (widget-put widget :glyph-down down))
    (when inactive (widget-put widget :glyph-inactive inactive))))


;;; Buttons.

(defgroup widget-button nil
  "The look of various kinds of buttons."
  :group 'widgets)

(defcustom widget-button-prefix ""
  "String used as prefix for buttons."
  :type 'string
  :group 'widget-button)

(defcustom widget-button-suffix ""
  "String used as suffix for buttons."
  :type 'string
  :group 'widget-button)


;;; Creating Widgets.

;;;###autoload
(defun widget-create (type &rest args)
  "Create widget of TYPE.
The optional ARGS are additional keyword arguments."
  (let ((widget (apply 'widget-convert type args)))
    (widget-apply widget :create)
    widget))

(defun widget-create-child-and-convert (parent type &rest args)
  "As part of the widget PARENT, create a child widget TYPE.
The child is converted, using the keyword arguments ARGS."
  (let ((widget (apply 'widget-convert type args)))
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
                    (or (widget-get widget :extra-offset) 0)
                    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

(defun widget-create-child (parent type)
  "Create widget of TYPE."
  (let ((widget (copy-sequence type)))
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
                    (or (widget-get widget :extra-offset) 0)
                    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

(defun widget-create-child-value (parent type value)
  "Create widget of TYPE with value VALUE."
  (let ((widget (copy-sequence type)))
    (widget-put widget :value (widget-apply widget :value-to-internal value))
    (widget-put widget :parent parent)
    (unless (widget-get widget :indent)
      (widget-put widget :indent (+ (or (widget-get parent :indent) 0)
                    (or (widget-get widget :extra-offset) 0)
                    (widget-get parent :offset))))
    (widget-apply widget :create)
    widget))

;;;###autoload
(defun widget-delete (widget)
  "Delete WIDGET."
  (widget-apply widget :delete))

(defun widget-convert (type &rest args)
  "Convert TYPE to a widget without inserting it in the buffer.
The optional ARGS are additional keyword arguments."
  ;; Don't touch the type.
  (let* ((widget (if (symbolp type)
             (list type)
           (copy-sequence type)))
     (current widget)
     (keys args))
    ;; First set the :args keyword.
    (while (cdr current)        ;Look in the type.
      (let ((next (car (cdr current))))
    (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
        (setq current (cdr (cdr current)))
      (setcdr current (list :args (cdr current)))
      (setq current nil))))
    (while args                ;Look in the args.
      (let ((next (nth 0 args)))
    (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
        (setq args (nthcdr 2 args))
      (widget-put widget :args args)
      (setq args nil))))
    ;; Then Convert the widget.
    (setq type widget)
    (while type
      (let ((convert-widget (plist-get (cdr type) :convert-widget)))
    (if convert-widget
        (setq widget (funcall convert-widget widget))))
      (setq type (get (car type) 'widget-type)))
    ;; Finally set the keyword args.
    (while keys
      (let ((next (nth 0 keys)))
    (if (and (symbolp next) (eq (aref (symbol-name next) 0) ?:))
        (progn
          (widget-put widget next (nth 1 keys))
          (setq keys (nthcdr 2 keys)))
      (setq keys nil))))
    ;; Convert the :value to internal format.
    (if (widget-member widget :value)
    (let ((value (widget-get widget :value)))
      (widget-put widget
              :value (widget-apply widget :value-to-internal value))))
    ;; Return the newly created widget.
    widget))

(defun widget-insert (&rest args)
  "Call `insert' with ARGS and make the text read only."
  (let ((inhibit-read-only t)
    before-change-functions
    after-change-functions)
    (apply 'insert args)))

(defun widget-convert-text (type from to
                 &optional button-from button-to
                 &rest args)
  "Return a widget of type TYPE with endpoint FROM TO.
Optional ARGS are extra keyword arguments for TYPE.
and TO will be used as the widgets end points. If optional arguments
BUTTON-FROM and BUTTON-TO are given, these will be used as the widgets
button end points.
Optional ARGS are extra keyword arguments for TYPE."
  (let ((widget (apply 'widget-convert type :delete 'widget-leave-text args))
    (from (copy-marker from))
    (to (copy-marker to)))
    (set-marker-insertion-type from t)
    (set-marker-insertion-type to nil)
    (widget-put widget :from from)
    (widget-put widget :to to)
    (when button-from
      (widget-specify-button widget button-from button-to))
    widget))

(defun widget-convert-button (type from to &rest args)
  "Return a widget of type TYPE with endpoint FROM TO.
Optional ARGS are extra keyword arguments for TYPE.
No text will be inserted to the buffer, instead the text between FROM
and TO will be used as the widgets end points, as well as the widgets
button end points."
  (apply 'widget-convert-text type from to from to args))

(defun widget-leave-text (widget)
  "Remove markers and extents from WIDGET and its children."
  (let ((from (widget-get widget :from))
    (to (widget-get widget :to))
    (button (widget-get widget :button-extent))
    (sample (widget-get widget :sample-extent))
    (doc (widget-get widget :doc-extent))
    (field (widget-get widget :field-extent))
    (children (widget-get widget :children)))
    (set-marker from nil)
    (set-marker to nil)
    ;; Maybe we should delete the extents here?  As this code doesn't
    ;; remove them from widget structures, maybe it's safer to just
    ;; detach them.  That's what `delete-overlay' did.
    (when button
      (detach-extent button))
    (when sample
      (detach-extent sample))
    (when doc
      (detach-extent doc))
    (when field
      (detach-extent field))
    (mapc 'widget-leave-text children)))


;;; Keymap and Commands.

(defvar widget-keymap nil
  "Keymap containing useful binding for buffers containing widgets.
Recommended as a parent keymap for modes using widgets.")

(unless widget-keymap
  (setq widget-keymap (make-sparse-keymap))
  (define-key widget-keymap [tab] 'widget-forward)
  (define-key widget-keymap [(shift tab)] 'widget-backward)
  (define-key widget-keymap [(meta tab)] 'widget-backward)
  (define-key widget-keymap [backtab] 'widget-backward))

(defvar widget-global-map global-map
  "Keymap used for events the widget does not handle themselves.")
(make-variable-buffer-local 'widget-global-map)

(defvar widget-field-keymap nil
  "Keymap used inside an editable field.")

(unless widget-field-keymap
  (setq widget-field-keymap (make-sparse-keymap))
  (set-keymap-parents widget-field-keymap global-map)
  (define-key widget-field-keymap "\C-k" 'widget-kill-line)
  (define-key widget-field-keymap [(meta tab)] 'widget-complete)
  (define-key widget-field-keymap [tab] 'widget-forward)
  (define-key widget-field-keymap [(shift tab)] 'widget-backward)
  (define-key widget-field-keymap "\C-m" 'widget-field-activate)
  (define-key widget-field-keymap "\C-a" 'widget-beginning-of-line)
  (define-key widget-field-keymap "\C-e" 'widget-end-of-line)
  (define-key widget-field-keymap "\C-t" 'widget-transpose-chars))

(defvar widget-text-keymap nil
  "Keymap used inside a text field.")

(unless widget-text-keymap
  (setq widget-text-keymap (make-sparse-keymap))
  (set-keymap-parents widget-field-keymap global-map)
  (define-key widget-text-keymap "\C-a" 'widget-beginning-of-line)
  (define-key widget-text-keymap "\C-e" 'widget-end-of-line)
  (define-key widget-text-keymap "\C-t" 'widget-transpose-chars))

(defvar widget-button-keymap nil
  "Keymap used inside a button.")

(unless widget-button-keymap
  (setq widget-button-keymap (make-sparse-keymap))
  (set-keymap-parents widget-button-keymap widget-keymap)
  (define-key widget-button-keymap "\C-m" 'widget-button-press)
  (define-key widget-button-keymap [button2] 'widget-button-click)
  ;; Ideally, button3 within a button should invoke a button-specific
  ;; menu.
  (define-key widget-button-keymap [button3] 'widget-button-click)
  ;;Glyph support.
  (define-key widget-button-keymap [button1] 'widget-button1-click))


(defun widget-field-activate (pos &optional event)
  "Invoke the ediable field at point."
  (interactive "@d")
  (let ((field (widget-field-find pos)))
    (if field
    (widget-apply-action field event)
      (call-interactively
       (lookup-key widget-global-map (this-command-keys))))))

(defface widget-button-pressed-face
  '((((class color))
     (:foreground "red"))
    (t
     (:bold t :underline t)))
  "Face used for pressed buttons."
  :group 'widget-faces)

(defun widget-event-point (event)
  "Character position of the mouse event, or nil."
  (and (mouse-event-p event)
       (event-point event)))

(defun widget-button-click (event)
  "Invoke button below mouse pointer."
  (interactive "@e")
  (cond ((event-glyph event)
     (widget-glyph-click event))
    ((widget-event-point event)
     (let* ((pos (widget-event-point event))
        (button (get-char-property pos 'button)))
       (if button
           (let* ((extent (widget-get button :button-extent))
              (face (extent-property extent 'face))
              (mouse-face (extent-property extent 'mouse-face))
              (help-echo (extent-property extent 'help-echo)))
         (unwind-protect
             (progn
               ;; Merge relevant faces, and make the result mouse-face.
               (let ((merge `(widget-button-pressed-face ,mouse-face)))
             (nconc merge (if (listp face)
                      face (list face)))
             (setq merge (delete-if-not 'find-face merge))
             (set-extent-property extent 'mouse-face merge))
               (unless (widget-apply button :mouse-down-action event)
             ;; Wait for button release.
             (while (not (button-release-event-p
                      (setq event (next-event))))
               (dispatch-event event)))
               ;; Disallow mouse-face and help-echo.
               (set-extent-property extent 'mouse-face nil)
               (set-extent-property extent 'help-echo nil)
               (setq pos (widget-event-point event))
               (unless (eq (current-buffer) (extent-object extent))
             ;; Barf if dispatch-event tripped us by
             ;; changing buffer.
             (error "Buffer changed during mouse motion"))
               ;; Do the associated action.
               (when (and pos (extent-in-region-p extent pos pos))
             (widget-apply-action button event)))
           ;; Unwinding: fully release the button.
           (set-extent-property extent 'mouse-face mouse-face)
           (set-extent-property extent 'help-echo help-echo)))
         ;; This should not happen!
         (error "`widget-button-click' called outside button"))))
    (t
     (message "You clicked somewhere weird"))))

(defun widget-button1-click (event)
  "Invoke glyph below mouse pointer."
  (interactive "@e")
  (if (event-glyph event)
      (widget-glyph-click event)
    ;; Should somehow avoid this.
    (let ((command (lookup-key widget-global-map (this-command-keys))))
      (and (commandp command)
       (call-interactively command)))))

(defun widget-glyph-click (event)
  "Handle click on a glyph."
  (let* ((glyph (event-glyph event))
     (extent (event-glyph-extent event))
     (widget (extent-property extent 'glyph-widget))
     (down-glyph (or (and widget (widget-get widget :glyph-down)) glyph))
     (up-glyph (or (and widget (widget-get widget :glyph-up)) glyph))
     (last event))
    (unless (widget-apply widget :active)
      (error "This widget is inactive"))
    (let ((current-glyph 'down))
      ;; We always know what glyph is drawn currently, to avoid
      ;; unnecessary extent changes.  Is this any noticable gain?
      (unwind-protect
      (progn
        ;; Press the glyph.
        (set-extent-end-glyph extent down-glyph)
        ;; Redisplay (shouldn't be needed, but...)
        (sit-for 0)
        (unless (widget-apply widget :mouse-down-action event)
          ;; Wait for the release.
          (while (not (button-release-event-p last))
        (unless (button-press-event-p last)
          (dispatch-event last))
        (when (motion-event-p last)
          ;; Update glyphs on mouse motion.
          (if (eq extent (event-glyph-extent last))
              (unless (eq current-glyph 'down)
            (set-extent-end-glyph extent down-glyph)
            (setq current-glyph 'down))
            (unless (eq current-glyph 'up)
              (set-extent-end-glyph extent up-glyph)
              (setq current-glyph 'up))))
        (setq last (next-event event))))
        (unless (eq (current-buffer) (extent-object extent))
          ;; Barf if dispatch-event tripped us by changing buffer.
          (error "Buffer changed during mouse motion"))
        ;; Apply widget action.
        (when (eq extent (event-glyph-extent last))
          (let ((widget (extent-property (event-glyph-extent event)
                         'glyph-widget)))
        (cond ((null widget)
               (message "You clicked on a glyph"))
              ((not (widget-apply widget :active))
               (error "This glyph is inactive"))
              (t
               (widget-apply-action widget event))))))
    ;; Release the glyph.
    (and (eq current-glyph 'down)
         ;; The extent might have been detached or deleted
         (extent-live-p extent)
         (not (extent-detached-p extent))
         (set-extent-end-glyph extent up-glyph))))))

(defun widget-button-press (pos &optional event)
  "Invoke button at POS."
  (interactive "@d")
  (let ((button (get-char-property pos 'button)))
    (if button
    (widget-apply-action button event)
      (let ((command (lookup-key widget-global-map (this-command-keys))))
    (when (commandp command)
      (call-interactively command))))))

(defun widget-tabable-at (&optional pos last-tab backwardp)
  "Return the tabable widget at POS, or nil.
POS defaults to the value of (point)."
  (unless pos
    (setq pos (point)))
  (let ((widget (widget-at pos)))
    (if widget
    (let ((order (widget-get widget :tab-order)))
      (if order
          (if last-tab (and (= order (if backwardp
                         (1- last-tab)
                       (1+ last-tab)))
                widget)
        (and (> order 0) widget))
        widget))
      nil)))

;; Return the button or field extent at point.
(defun widget-button-or-field-extent (pos)
  (or (and (get-char-property pos 'button)
       (widget-get (get-char-property pos 'button)
               :button-extent))
      (and (get-char-property pos 'field)
       (widget-get (get-char-property pos 'field)
               :field-extent))))

(defun widget-next-button-or-field (pos)
  "Find the next button, or field, and return its start position, or nil.
Internal function, don't use it outside `wid-edit'."
  (let* ((at-point (widget-button-or-field-extent pos))
     (extent (map-extents
          (lambda (ext ignore)
            ext)
          nil (if at-point (extent-end-position at-point) pos)
          nil nil 'start-open 'button-or-field)))
    (and extent
     (extent-start-position extent))))

;; This is too slow in buffers with many buttons (W3).
(defun widget-previous-button-or-field (pos)
  "Find the previous button, or field, and return its start position, or nil.
Internal function, don't use it outside `wid-edit'."
  (let* ((at-point (widget-button-or-field-extent pos))
     previous-extent)
    (map-extents
     (lambda (ext ignore)
       (if (eq ext at-point)
       ;; We reached the extent we were on originally
       (if (= pos (extent-start-position at-point))
           previous-extent
         (setq previous-extent at-point))
     (setq previous-extent ext)
     nil))
     nil nil pos nil 'start-open 'button-or-field)
    (and previous-extent
     (extent-start-position previous-extent))))

(defun widget-move (arg)
  "Move point to the ARG next field or button.
ARG may be negative to move backward."
  (let ((opoint (point)) (wrapped 0)
    (last-tab (widget-get (widget-at (point)) :tab-order))
    nextpos found)
    ;; Movement backward
    (while (< arg 0)
      (setq nextpos (widget-previous-button-or-field (point)))
      (if nextpos
      (progn
        (goto-char nextpos)
        (when (and (not (get-char-property nextpos 'widget-inactive))
               (widget-tabable-at nil last-tab t))
          (incf arg)
          (setq found t
            last-tab (widget-get (widget-at (point))
                     :tab-order))))
    (if (and (not found) (> wrapped 1))
        (setq arg 0
          found nil)
      (goto-char (point-max))
      (incf wrapped))))
    ;; Movement forward
    (while (> arg 0)
      (setq nextpos (widget-next-button-or-field (point)))
      (if nextpos
      (progn
        (goto-char nextpos)
        (when (and (not (get-char-property nextpos 'widget-inactive))
               (widget-tabable-at nil last-tab))
          (decf arg)
          (setq found t
            last-tab (widget-get (widget-at (point))
                     :tab-order))))
    (if (and (not found) (> wrapped 1))
        (setq arg 0
          found nil)
      (goto-char (point-min))
      (incf wrapped))))
    (if (not found)
    (goto-char opoint)
      (widget-echo-help (point))
      (run-hooks 'widget-move-hook))))

(defun widget-forward (arg)
  "Move point to the next field or button.
With optional ARG, move across that many fields."
  (interactive "p")
  (run-hooks 'widget-forward-hook)
  (widget-move arg))

(defun widget-backward (arg)
  "Move point to the previous field or button.
With optional ARG, move across that many fields."
  (interactive "p")
  (run-hooks 'widget-backward-hook)
  (widget-move (- arg)))

(defun widget-beginning-of-line ()
  "Go to beginning of field or beginning of line, whichever is first."
  (interactive "_")
  (let* ((field (widget-field-find (point)))
     (start (and field (widget-field-start field))))
    (if (and start (not (eq start (point))))
    (goto-char start)
      (call-interactively 'beginning-of-line))))

(defun widget-end-of-line ()
  "Go to end of field or end of line, whichever is first."
  (interactive "_")
  (let* ((field (widget-field-find (point)))
     (end (and field (widget-field-end field))))
    (if (and end (not (eq end (point))))
    (goto-char end)
      (call-interactively 'end-of-line))))

(defun widget-kill-line ()
  "Kill to end of field or end of line, whichever is first."
  (interactive)
  (let* ((field (widget-field-find (point)))
     (newline (save-excursion (forward-line 1) (point)))
     (end (and field (widget-field-end field))))
    (if (and field (> newline end))
    (kill-region (point) end)
      (call-interactively 'kill-line))))

(defun widget-transpose-chars (arg)
  "Like `transpose-chars', but works correctly at end of widget."
  (interactive "*P")
  (let* ((field (widget-field-find (point)))
     (start (and field (widget-field-start field)))
     (end (and field (widget-field-end field)))
     (last-non-space (and start end
                  (save-excursion
                (goto-char end)
                (skip-chars-backward " \t\n" start)
                (point)))))
    (cond ((and last-non-space
        (or (= last-non-space start)
            (= last-non-space (1+ start))))
       ;; empty or one-character field
       nil)
      ((= (point) start)
       ;; at the beginning of the field -- we would get an error here.
       (error "Cannot transpose at beginning of field"))
      (t
       (when (and (null arg)
              (= last-non-space (point)))
         (forward-char -1))
       (transpose-chars arg)))))

(defcustom widget-complete-field (lookup-key global-map "\M-\t")
  "Default function to call for completion inside fields."
  :options '(ispell-complete-word complete-tag lisp-complete-symbol)
  :type 'function
  :group 'widgets)

(defun widget-complete ()
  "Complete content of editable field from point.
When not inside a field, move to the previous button or field."
  (interactive)
  ;; Somehow, this should make pressing M-TAB twice scroll the
  ;; completions window.
  (let ((field (widget-field-find (point))))
    (if field
    (widget-apply field :complete)
      (error "Not in an editable field"))))


;;; Setting up the buffer.

(defvar widget-field-new nil)
;; List of all newly created editable fields in the buffer.
(make-variable-buffer-local 'widget-field-new)

(defvar widget-field-list nil)
;; List of all editable fields in the buffer.
(make-variable-buffer-local 'widget-field-list)

(defun widget-setup ()
  "Setup current buffer so editing string widgets works."
  (let ((inhibit-read-only t)
    (after-change-functions nil)
    before-change-functions
    field)
    (while widget-field-new
      (setq field (car widget-field-new)
        widget-field-new (cdr widget-field-new)
        widget-field-list (cons field widget-field-list))
      (let ((from (car (widget-get field :field-extent)))
        (to (cdr (widget-get field :field-extent))))
    (widget-specify-field field
                  (marker-position from) (marker-position to))
    (set-marker from nil)
    (set-marker to nil))
      ;; If the field is placed within the inactive zone, deactivate it.
      (let ((extent (widget-get field :field-extent)))
    (when (get-char-property (extent-start-position extent)
                 'widget-inactive)
      (widget-activation-widget-mapper extent :deactivate)))))
  (widget-clear-undo)
  (widget-add-change))

(defvar widget-field-last nil)
;; Last field containing point.
(make-variable-buffer-local 'widget-field-last)

(defvar widget-field-was nil)
;; The widget data before the change.
(make-variable-buffer-local 'widget-field-was)

(defun widget-field-buffer (widget)
  "Return the start of WIDGET's editing field."
  (let ((extent (widget-get widget :field-extent)))
    (and extent (extent-object extent))))

(defun widget-field-start (widget)
  "Return the start of WIDGET's editing field."
  (let ((extent (widget-get widget :field-extent)))
    (and extent (extent-start-position extent))))

(defun widget-field-end (widget)
  "Return the end of WIDGET's editing field."
  (let ((extent (widget-get widget :field-extent)))
    ;; Don't subtract one if local-map works at the end of the extent.
    (and extent (if (or widget-field-add-space
            (null (widget-get widget :size)))
            (1- (extent-end-position extent))
          (extent-end-position extent)))))

(defun widget-field-find (pos)
  "Return the field at POS.
Unlike (get-char-property POS 'field) this, works with empty fields too."
  (let ((field-extent (map-extents (lambda (extent ignore)
                     extent)
                   nil pos pos nil nil 'field)))
    (and field-extent
     (extent-property field-extent 'field))))

;; Old version, without `map-extents'.
;(defun widget-field-find (pos)
;  (let ((fields widget-field-list)
;    field found)
;    (while fields
;      (setq field (car fields)
;        fields (cdr fields))
;      (let ((start (widget-field-start field))
;        (end (widget-field-end field)))
;    (when (and (<= start pos) (<= pos end))
;      (when found
;        (debug "Overlapping fields"))
;      (setq found field))))
;    found))

(defun widget-before-change (from to)
  ;; Barf if the text changed is outside the editable fields.
  (unless inhibit-read-only
    (let ((from-field (widget-field-find from))
      (to-field (widget-field-find to)))
      (cond ((or (null from-field)
         (null to-field))
         ;; Either end of change is not within a field.
         (add-hook 'post-command-hook 'widget-add-change nil t)
         (error "Attempt to change text outside editable field"))
        ((not (eq from-field to-field))
         ;; The change begins in one fields, and ends in another one.
         (add-hook 'post-command-hook 'widget-add-change nil t)
         (error "Change should be restricted to a single field"))
        ((or (and from-field
              (get-char-property from 'widget-inactive))
         (and to-field
              (get-char-property to 'widget-inactive)))
         ;; Trying to change an inactive editable field.
         (add-hook 'post-command-hook 'widget-add-change nil t)
         (error "Attempt to change an inactive field"))
        (widget-field-use-before-change
         ;; #### Bletch!  This loses because XEmacs get confused
         ;; if before-change-functions change the contents of
         ;; buffer before from/to.
         (condition-case nil
         (widget-apply from-field :notify from-field)
           (error (debug "Before Change"))))))))

(defun widget-add-change ()
  (make-local-hook 'post-command-hook)
  (remove-hook 'post-command-hook 'widget-add-change t)
  (make-local-hook 'before-change-functions)
  (add-hook 'before-change-functions 'widget-before-change nil t)
  (make-local-hook 'after-change-functions)
  (add-hook 'after-change-functions 'widget-after-change nil t))

(defun widget-after-change (from to old)
  ;; Adjust field size and text properties.

  ;; Also, notify the widgets (so, for example, a variable changes its
  ;; state to `modified'.  when it is being edited.)
  (condition-case nil
      (let ((field (widget-field-find from))
        (other (widget-field-find to)))
    (when field
      (unless (eq field other)
        (debug "Change in different fields"))
      (let ((size (widget-get field :size))
        (secret (widget-get field :secret)))
        (when size
          (let ((begin (widget-field-start field))
            (end (widget-field-end field)))
        (cond ((< (- end begin) size)
               ;; Field too small.
               (save-excursion
             (goto-char end)
             (insert-char ?\  (- (+ begin size) end))))
              ((> (- end begin) size)
               ;; Field too large and
               (if (or (< (point) (+ begin size))
                   (> (point) end))
               ;; Point is outside extra space.
               (setq begin (+ begin size))
             ;; Point is within the extra space.
             (setq begin (point)))
               (save-excursion
             (goto-char end)
             (while (and (eq (preceding-char) ?\ )
                     (> (point) begin))
               (delete-backward-char 1)))))))
        (when secret
          (let ((begin (widget-field-start field))
            (end (widget-field-end field)))
        (when size
          (while (and (> end begin)
                  (eq (char-after (1- end)) ?\ ))
            (setq end (1- end))))
        (while (< begin end)
          (let ((old (char-after begin)))
            (unless (eq old secret)
              (subst-char-in-region begin (1+ begin) old secret)
              (put-text-property begin (1+ begin) 'secret old))
            (incf begin))))))
      (widget-apply field :notify field)))
    (error (debug "After Change"))))


;;; Widget Functions
;;
;; These functions are used in the definition of multiple widgets.

(defun widget-parent-action (widget &optional event)
  "Tell :parent of WIDGET to handle the :action.
Optional EVENT is the event that triggered the action."
  (widget-apply (widget-get widget :parent) :action event))

(defun widget-children-value-delete (widget)
  "Delete all :children and :buttons in WIDGET."
  (mapc 'widget-delete (widget-get widget :children))
  (widget-put widget :children nil)
  (mapc 'widget-delete (widget-get widget :buttons))
  (widget-put widget :buttons nil))

(defun widget-children-validate (widget)
  "All the :children must be valid."
  (let ((children (widget-get widget :children))
    child found)
    (while (and children (not found))
      (setq child (car children)
        children (cdr children)
        found (widget-apply child :validate)))
    found))

(defun widget-types-convert-widget (widget)
  "Convert :args as widget types in WIDGET."
  (widget-put widget :args (mapcar 'widget-convert (widget-get widget :args)))
  widget)

(defun widget-value-convert-widget (widget)
  "Initialize :value from :args in WIDGET."
  (let ((args (widget-get widget :args)))
    (when args
      (widget-put widget :value (car args))
      ;; Don't convert :value here, as this is done in `widget-convert'.
      ;; (widget-put widget :value (widget-apply widget
      ;; :value-to-internal (car args)))
      (widget-put widget :args nil)))
  widget)

(defun widget-value-value-get (widget)
  "Return the :value property of WIDGET."
  (widget-get widget :value))

;;; The `default' Widget.

(define-widget 'default nil
  "Basic widget other widgets are derived from."
  :value-to-internal (lambda (widget value) value)
  :value-to-external (lambda (widget value) value)
  :button-prefix 'widget-button-prefix
  :button-suffix 'widget-button-suffix
  :complete 'widget-default-complete
  :create 'widget-default-create
  :indent nil
  :offset 0
  :format-handler 'widget-default-format-handler
  :button-face-get 'widget-default-button-face-get
  :sample-face-get 'widget-default-sample-face-get
  :button-keymap widget-button-keymap
  :delete 'widget-default-delete
  :value-set 'widget-default-value-set
  :value-inline 'widget-default-value-inline
  :menu-tag-get 'widget-default-menu-tag-get
  :validate (lambda (widget) nil)
  :active 'widget-default-active
  :activate 'widget-specify-active
  :deactivate 'widget-default-deactivate
  :mouse-down-action (lambda (widget event) nil)
  :action 'widget-default-action
  :notify 'widget-default-notify
  :prompt-value 'widget-default-prompt-value)

(defun widget-default-complete (widget)
  "Call the value of the :complete-function property of WIDGET.
If that does not exists, call the value of `widget-complete-field'."
  (let ((fun (widget-get widget :complete-function)))
    (call-interactively (or fun widget-complete-field))))

(defun widget-default-create (widget)
  "Create WIDGET at point in the current buffer."
  (widget-specify-insert
   (let ((from (point))
     button-begin button-end button-glyph
     sample-begin sample-end
     doc-begin doc-end
     value-pos)
     (insert (widget-get widget :format))
     (goto-char from)
     ;; Parse escapes in format.  Coding this in C would speed up
     ;; things *a lot*.
     (while (re-search-forward "%\\(.\\)" nil t)
       (let ((escape (aref (match-string 1) 0)))
     (replace-match "" t t)
     (cond ((eq escape ?%)
        (insert "%"))
           ((eq escape ?\[)
        (setq button-begin (point-marker))
        (set-marker-insertion-type button-begin nil))
           ((eq escape ?\])
        (setq button-end (point-marker))
        (set-marker-insertion-type button-end nil))
           ((eq escape ?\{)
        (setq sample-begin (point)))
           ((eq escape ?\})
        (setq sample-end (point)))
           ((eq escape ?n)
        (when (widget-get widget :indent)
          (insert "\n")
          (insert-char ?\  (widget-get widget :indent))))
           ((eq escape ?t)
        (let* ((tag (widget-get widget :tag))
               (glyph (widget-get widget :tag-glyph)))
          (cond (glyph
             (setq button-glyph
                   (widget-glyph-insert
                widget (or tag "Image") glyph)))
            (tag
             (insert tag))
            (t
             (let ((standard-output (current-buffer)))
               (princ (widget-get widget :value)))))))
           ((eq escape ?d)
        (let ((doc (widget-get widget :doc)))
          (when doc
            (setq doc-begin (point))
            (insert doc)
            (while (eq (preceding-char) ?\n)
              (delete-backward-char 1))
            (insert "\n")
            (setq doc-end (point)))))
           ((eq escape ?v)
        (if (and button-begin (not button-end))
            (widget-apply widget :value-create)
          (setq value-pos (point-marker))))
           (t
        (widget-apply widget :format-handler escape)))))
     ;; Specify button, sample, and doc, and insert value.
     (when (and button-begin button-end)
       (unless button-glyph
     (goto-char button-begin)
     (insert (widget-get-indirect widget :button-prefix))
     (goto-char button-end)
     (set-marker-insertion-type button-end t)
     (insert (widget-get-indirect widget :button-suffix)))
       (widget-specify-button widget button-begin button-end)
       ;; Is this necessary?
       (set-marker button-begin nil)
       (set-marker button-end nil))
     (and sample-begin sample-end
      (widget-specify-sample widget sample-begin sample-end))
     (and doc-begin doc-end
      (widget-specify-doc widget doc-begin doc-end))
     (when value-pos
       (goto-char value-pos)
       (widget-apply widget :value-create)))
   (let ((from (point-min-marker))
     (to (point-max-marker)))
     (set-marker-insertion-type from t)
     (set-marker-insertion-type to nil)
     (widget-put widget :from from)
     (widget-put widget :to to)))
  (widget-clear-undo))

(defun widget-default-format-handler (widget escape)
  ;; We recognize the %h escape by default.
  (let* ((buttons (widget-get widget :buttons)))
    (cond ((eq escape ?h)
       (let* ((doc-property (widget-get widget :documentation-property))
          (doc-try (cond ((widget-get widget :doc))
                 ((symbolp doc-property)
                  (documentation-property
                   (widget-get widget :value)
                   doc-property))
                 (t
                  (funcall doc-property
                       (widget-get widget :value)))))
          (doc-text (and (stringp doc-try)
                 (> (length doc-try) 1)
                 doc-try))
          (doc-indent (widget-get widget :documentation-indent)))
         (when doc-text
           (and (eq (preceding-char) ?\n)
            (widget-get widget :indent)
            (insert-char ?\  (widget-get widget :indent)))
           ;; The `*' in the beginning is redundant.
           (when (eq (aref doc-text  0) ?*)
         (setq doc-text (substring doc-text 1)))
           ;; Get rid of trailing newlines.
           (when (string-match "\n+\\'" doc-text)
         (setq doc-text (substring doc-text 0 (match-beginning 0))))
           (push (widget-create-child-and-convert
              widget 'documentation-string
              :indent (cond ((numberp doc-indent)
                     doc-indent)
                    ((null doc-indent)
                     nil)
                    (t 0))
              doc-text)
             buttons))))
      (t
       (error "Unknown escape `%c'" escape)))
    (widget-put widget :buttons buttons)))

(defun widget-default-button-face-get (widget)
  ;; Use :button-face or widget-button-face
  (or (widget-get widget :button-face)
      (let ((parent (widget-get widget :parent)))
    (if parent
        (widget-apply parent :button-face-get)
      widget-button-face))))

(defun widget-default-sample-face-get (widget)
  ;; Use :sample-face.
  (widget-get widget :sample-face))

(defun widget-default-delete (widget)
  ;; Remove widget from the buffer.
  (let ((from (widget-get widget :from))
    (to (widget-get widget :to))
    (inactive-extent (widget-get widget :inactive))
    (button-extent (widget-get widget :button-extent))
    (sample-extent (widget-get widget :sample-extent))
    (doc-extent (widget-get widget :doc-extent))
    before-change-functions
    after-change-functions
    (inhibit-read-only t))
    (widget-apply widget :value-delete)
    (when inactive-extent
      (detach-extent inactive-extent))
    (when button-extent
      (detach-extent button-extent))
    (when sample-extent
      (detach-extent sample-extent))
    (when doc-extent
      (detach-extent doc-extent))
    (when (< from to)
      ;; Kludge: this doesn't need to be true for empty formats.
      (delete-region from to))
    (set-marker from nil)
    (set-marker to nil))
  (widget-clear-undo))

(defun widget-default-value-set (widget value)
  ;; Recreate widget with new value.
  (let* ((old-pos (point))
     (from (copy-marker (widget-get widget :from)))
     (to (copy-marker (widget-get widget :to)))
     (offset (if (and (<= from old-pos) (<= old-pos to))
             (if (>= old-pos (1- to))
             (- old-pos to 1)
               (- old-pos from)))))
    ;;??? Bug: this ought to insert the new value before deleting the old one,
    ;; so that markers on either side of the value automatically
    ;; stay on the same side.  -- rms.
    (save-excursion
      (goto-char (widget-get widget :from))
      (widget-apply widget :delete)
      (widget-put widget :value value)
      (widget-apply widget :create))
    (when offset
      (if (< offset 0)
      (goto-char (+ (widget-get widget :to) offset 1))
    (goto-char (min (+ from offset) (1- (widget-get widget :to))))))))

(defun widget-default-value-inline (widget)
  ;; Wrap value in a list unless it is inline.
  (if (widget-get widget :inline)
      (widget-value widget)
    (list (widget-value widget))))

(defun widget-default-menu-tag-get (widget)
  ;; Use tag or value for menus.
  (or (widget-get widget :menu-tag)
      (widget-get widget :tag)
      (widget-princ-to-string (widget-get widget :value))))

(defun widget-default-active (widget)
  "Return t iff this widget active (user modifiable)."
  (and (not (widget-get widget :inactive))
       (let ((parent (widget-get widget :parent)))
     (or (null parent)
         (widget-apply parent :active)))))

(defun widget-default-deactivate (widget)
  "Make WIDGET inactive for user modifications."
  (widget-specify-inactive widget
               (widget-get widget :from)
               (widget-get widget :to)))

(defun widget-default-action (widget &optional event)
  ;; Notify the parent when a widget change
  (let ((parent (widget-get widget :parent)))
    (when parent
      (widget-apply parent :notify widget event))))

(defun widget-default-notify (widget child &optional event)
  ;; Pass notification to parent.
  (widget-default-action widget event))

(defun widget-default-prompt-value (widget prompt value unbound)
  ;; Read an arbitrary value.  Stolen from `set-variable'.
;;  (let ((initial (if unbound
;;             nil
;;           ;; It would be nice if we could do a `(cons val 1)' here.
;;           (prin1-to-string (custom-quote value))))))
  (eval-minibuffer prompt ))

;;; The `item' Widget.

(define-widget 'item 'default
  "Constant items for inclusion in other widgets."
  :convert-widget 'widget-value-convert-widget
  :value-create 'widget-item-value-create
  :value-delete 'ignore
  :value-get 'widget-value-value-get
  :match 'widget-item-match
  :match-inline 'widget-item-match-inline
  :action 'widget-item-action
  :format "%t\n")

(defun widget-item-value-create (widget)
  ;; Insert the printed representation of the value.
  (let ((standard-output (current-buffer)))
    (princ (widget-get widget :value))))

(defun widget-item-match (widget value)
  ;; Match if the value is the same.
  (equal (widget-get widget :value) value))

(defun widget-item-match-inline (widget values)
  ;; Match if the value is the same.
  (let ((value (widget-get widget :value)))
    (and (listp value)
     (<= (length value) (length values))
     (let ((head (widget-sublist values 0 (length value))))
       (and (equal head value)
        (cons head (widget-sublist values (length value))))))))

(defun widget-sublist (list start &optional end)
  "Return the sublist of LIST from START to END.
If END is omitted, it defaults to the length of LIST."
  (if (> start 0) (setq list (nthcdr start list)))
  (if end
      (if (<= end start)
      nil
    (setq list (copy-sequence list))
    (setcdr (nthcdr (- end start 1) list) nil)
    list)
    (copy-sequence list)))

(defun widget-item-action (widget &optional event)
  ;; Just notify itself.
  (widget-apply widget :notify widget event))

;;; The `push-button' Widget.

(defcustom widget-push-button-gui widget-glyph-enable
  "If non nil, use GUI push buttons when available."
  :group 'widgets
  :type 'boolean)

;; Cache already created GUI objects.
(defvar widget-push-button-cache nil)

(defcustom widget-push-button-prefix "["
  "String used as prefix for buttons."
  :type 'string
  :group 'widget-button)

(defcustom widget-push-button-suffix "]"
  "String used as suffix for buttons."
  :type 'string
  :group 'widget-button)

(define-widget 'push-button 'item
  "A pushable button."
  :button-prefix ""
  :button-suffix ""
  :value-create 'widget-push-button-value-create
  :format "%[%v%]")

(defun widget-push-button-value-create (widget)
  ;; Insert text representing the `on' and `off' states.
  (let* ((tag (or (widget-get widget :tag)
          (widget-get widget :value)))
     (tag-glyph (widget-get widget :tag-glyph))
     (text (concat widget-push-button-prefix
               tag widget-push-button-suffix))
     (gui-glyphs (lax-plist-get widget-push-button-cache tag)))
    (cond (tag-glyph
       (widget-glyph-insert widget text tag-glyph))
      ;; We must check for console-on-window-system-p here,
      ;; because GUI will not work otherwise (it needs RGB
      ;; components for colors, and they are not known on TTYs).
      ((and widget-push-button-gui
        (console-on-window-system-p))
       (unless gui-glyphs
         (let* ((gui-button-shadow-thickness 1)
            (gui (make-gui-button tag 'widget-gui-action widget)))
           (setq
        gui-glyphs
        (list
         (make-glyph `(,(nth 0 (aref gui 1)) [string :data ,text]))
         (make-glyph `(,(nth 1 (aref gui 1)) [string :data ,text]))
         (make-glyph `(,(nth 2 (aref gui 1)) [string :data ,text]))))
           (laxputf widget-push-button-cache tag gui-glyphs)))
       (widget-glyph-insert-glyph
        widget (nth 0 gui-glyphs) (nth 1 gui-glyphs) (nth 2 gui-glyphs)))
      (t
       (insert text)))))

(defun widget-gui-action (widget)
  "Apply :action for WIDGET."
  (widget-apply-action widget (this-command-keys)))

;;; The `link' Widget.

(defcustom widget-link-prefix "["
  "String used as prefix for links."
  :type 'string
  :group 'widget-button)

(defcustom widget-link-suffix "]"
  "String used as suffix for links."
  :type 'string
  :group 'widget-button)

(define-widget 'link 'item
  "An embedded link."
  :button-prefix 'widget-link-prefix
  :button-suffix 'widget-link-suffix
  :help-echo "Follow the link"
  :format "%[%t%]")

;;; The `info-link' Widget.

(define-widget 'info-link 'link
  "A link to an info file."
  :help-echo 'widget-info-link-help-echo
  :action 'widget-info-link-action)

(defun widget-info-link-help-echo (widget)
  (concat "Read the manual entry `" (widget-value widget) "'"))

(defun widget-info-link-action (widget &optional event)
  "Open the info node specified by WIDGET."
  (Info-goto-node (widget-value widget)))

;;; The `url-link' Widget.

(define-widget 'url-link 'link
  "A link to an www page."
  :help-echo 'widget-url-link-help-echo
  :action 'widget-url-link-action)

(defun widget-url-link-help-echo (widget)
  (concat "Visit <URL:" (widget-value widget) ">"))

(defun widget-url-link-action (widget &optional event)
  "Open the url specified by WIDGET."
  (require 'browse-url)
  (funcall browse-url-browser-function (widget-value widget)))

;;; The `function-link' Widget.

(define-widget 'function-link 'link
  "A link to an Emacs function."
  :action 'widget-function-link-action)

(defun widget-function-link-action (widget &optional event)
  "Show the function specified by WIDGET."
  (describe-function (widget-value widget)))

;;; The `variable-link' Widget.

(define-widget 'variable-link 'link
  "A link to an Emacs variable."
  :action 'widget-variable-link-action)

(defun widget-variable-link-action (widget &optional event)
  "Show the variable specified by WIDGET."
  (describe-variable (widget-value widget)))

;;; The `file-link' Widget.

(define-widget 'file-link 'link
  "A link to a file."
  :action 'widget-file-link-action)

(defun widget-file-link-action (widget &optional event)
  "Find the file specified by WIDGET."
  (find-file (widget-value widget)))

;;; The `emacs-library-link' Widget.

(define-widget 'emacs-library-link 'link
  "A link to an Emacs Lisp library file."
  :help-echo 'widget-emacs-library-link-help-echo
  :action 'widget-emacs-library-link-action)

(defun widget-emacs-library-link-help-echo (widget)
  (concat "Visit " (widget-value widget)))

(defun widget-emacs-library-link-action (widget &optional event)
  "Find the Emacs Library file specified by WIDGET."
  (find-file (locate-library (widget-value widget))))

;;; The `emacs-commentary-link' Widget.

(define-widget 'emacs-commentary-link 'link
  "A link to Commentary in an Emacs Lisp library file."
  :action 'widget-emacs-commentary-link-action)

(defun widget-emacs-commentary-link-action (widget &optional event)
  "Find the Commentary section of the Emacs file specified by WIDGET."
  (finder-commentary (widget-value widget)))

;;; The `editable-field' Widget.

(define-widget 'editable-field 'default
  "An editable text field."
  :convert-widget 'widget-value-convert-widget
  :keymap widget-field-keymap
  :format "%v"
  :value ""
  :prompt-internal 'widget-field-prompt-internal
  :prompt-history 'widget-field-history
  :prompt-value 'widget-field-prompt-value
  :action 'widget-field-action
  :validate 'widget-field-validate
  :valid-regexp ""
  :error "No match"
  :value-create 'widget-field-value-create
  :value-delete 'widget-field-value-delete
  :value-get 'widget-field-value-get
  :match 'widget-field-match)

(defvar widget-field-history nil
  "History of field minibuffer edits.")

(defun widget-field-prompt-internal (widget prompt initial history)
  ;; Read string for WIDGET prompting with PROMPT.
  ;; INITIAL is the initial input and HISTORY is a symbol containing
  ;; the earlier input.
  (read-string prompt initial history))

(defun widget-field-prompt-value (widget prompt value unbound)
  ;; Prompt for a string.
  (let ((initial (if unbound
             nil
           (cons (widget-apply widget :value-to-internal
                       value) 0)))
    (history (widget-get widget :prompt-history)))
    (let ((answer (widget-apply widget
                :prompt-internal prompt initial history)))
      (widget-apply widget :value-to-external answer))))

(defvar widget-edit-functions nil)

(defun widget-field-action (widget &optional event)
  ;; Edit the value in the minibuffer.
  (let* ((invalid (widget-apply widget :validate))
     (prompt (concat (widget-apply widget :menu-tag-get) ": "))
     (value (unless invalid
          (widget-value widget)))
     (answer (widget-apply widget :prompt-value prompt value invalid)))
    (unless (equal value answer)
      ;; This is a hack.  We can't properly validate the widget
      ;; because validation requires the new value to be in the field.
      ;; However, widget-field-value-create will not function unless
      ;; the new value matches.  So, we check whether the thing
      ;; matches, and if it does, use either the real or a dummy error
      ;; message.
      (unless (widget-apply widget :match answer)
    (let ((error-message (or (widget-get widget :type-error)
                 "Invalid field contents")))
      (widget-put widget :error error-message)
      (error error-message)))
      (widget-value-set widget answer)
      (widget-apply widget :notify widget event)
      (widget-setup))
    (run-hook-with-args 'widget-edit-functions widget)))

;(defun widget-field-action (widget &optional event)
;  ;; Move to next field.
;  (widget-forward 1)
;  (run-hook-with-args 'widget-edit-functions widget))

(defun widget-field-validate (widget)
  ;; Valid if the content matches `:valid-regexp'.
  (save-excursion
    (let ((value (widget-apply widget :value-get))
      (regexp (widget-get widget :valid-regexp)))
      (if (string-match regexp value)
      nil
    widget))))

(defun widget-field-value-create (widget)
  ;; Create an editable text field.
  (let ((size (widget-get widget :size))
    (value (widget-get widget :value))
    (from (point))
    ;; This is changed to a real extent in `widget-setup'.  We
    ;; need the end points to behave differently until
    ;; `widget-setup' is called.  Should probably be replaced with
    ;; a genuine extent, but some things break, then.
    (extent (cons (make-marker) (make-marker))))
    (widget-put widget :field-extent extent)
    (insert value)
    (and size
     (< (length value) size)
     (insert-char ?\  (- size (length value))))
    (unless (memq widget widget-field-list)
      (push widget widget-field-new))
    (move-marker (cdr extent) (point))
    (set-marker-insertion-type (cdr extent) nil)
    (when (null size)
      (insert ?\n))
    (move-marker (car extent) from)
    (set-marker-insertion-type (car extent) t)))

(defun widget-field-value-delete (widget)
  ;; Remove the widget from the list of active editing fields.
  (setq widget-field-list (delq widget widget-field-list))
  ;; These are nil if the :format string doesn't contain `%v'.
  (let ((extent (widget-get widget :field-extent)))
    (when extent
      (detach-extent extent))))

(defun widget-field-value-get (widget)
  ;; Return current text in editing field.
  (let ((from (widget-field-start widget))
    (to (widget-field-end widget))
    (buffer (widget-field-buffer widget))
    (size (widget-get widget :size))
    (secret (widget-get widget :secret))
    (old (current-buffer)))
    (cond
     ((and from to)
      (set-buffer buffer)
      (while (and size
          (not (zerop size))
          (> to from)
          (eq (char-after (1- to)) ?\ ))
    (setq to (1- to)))
      (let ((result (buffer-substring-no-properties from to)))
    (when secret
      (let ((index 0))
        (while (< (+ from index) to)
          (aset result index
            (get-char-property (+ from index) 'secret))
          (incf index))))
    (set-buffer old)
    result))
     (t
      (widget-get widget :value)))))

(defun widget-field-match (widget value)
  ;; Match any string.
  (stringp value))

;;; The `text' Widget.

(define-widget 'text 'editable-field
  :keymap widget-text-keymap
  "A multiline text area.")

;;; The `menu-choice' Widget.

(define-widget 'menu-choice 'default
  "A menu of options."
  :convert-widget  'widget-types-convert-widget
  :format "%[%t%]: %v"
  :case-fold t
  :tag "choice"
  :void '(item :format "invalid (%t)\n")
  :value-create 'widget-choice-value-create
  :value-delete 'widget-children-value-delete
  :value-get 'widget-choice-value-get
  :value-inline 'widget-choice-value-inline
  :mouse-down-action 'widget-choice-mouse-down-action
  :action 'widget-choice-action
  :error "Make a choice"
  :validate 'widget-choice-validate
  :match 'widget-choice-match
  :match-inline 'widget-choice-match-inline)

(defun widget-choice-value-create (widget)
  ;; Insert the first choice that matches the value.
  (let ((value (widget-get widget :value))
    (args (widget-get widget :args))
    current)
    (while args
      (setq current (car args)
        args (cdr args))
      (when (widget-apply current :match value)
    (widget-put widget :children (list (widget-create-child-value
                        widget current value)))
    (widget-put widget :choice current)
    (setq args nil
          current nil)))
    (when current
      (let ((void (widget-get widget :void)))
    (widget-put widget :children (list (widget-create-child-and-convert
                        widget void :value value)))
    (widget-put widget :choice void)))))

(defun widget-choice-value-get (widget)
  ;; Get value of the child widget.
  (widget-value (car (widget-get widget :children))))

(defun widget-choice-value-inline (widget)
  ;; Get value of the child widget.
  (widget-apply (car (widget-get widget :children)) :value-inline))

(defcustom widget-choice-toggle nil
  "If non-nil, a binary choice will just toggle between the values.
Otherwise, the user will explicitly have to choose between the values
when he invoked the menu."
  :type 'boolean
  :group 'widgets)

(defun widget-choice-mouse-down-action (widget &optional event)
  ;; Return non-nil if we need a menu.
  (let ((args (widget-get widget :args))
    (old (widget-get widget :choice)))
    (cond ((not (console-on-window-system-p))
       ;; No place to pop up a menu.
       nil)
      ((< (length args) 2)
       ;; Empty or singleton list, just return the value.
       nil)
      ((> (length args) widget-menu-max-size)
       ;; Too long, prompt.
       nil)
      ((> (length args) 2)
       ;; Reasonable sized list, use menu.
       t)
      ((and widget-choice-toggle (memq old args))
       ;; We toggle.
       nil)
      (t
       ;; Ask which of the two.
       t))))

(defun widget-choice-action (widget &optional event)
  ;; Make a choice.
  (let ((args (widget-get widget :args))
    (old (widget-get widget :choice))
    (tag (widget-apply widget :menu-tag-get))
    (completion-ignore-case (widget-get widget :case-fold))
    current choices)
    ;; Remember old value.
    (if (and old (not (widget-apply widget :validate)))
    (let* ((external (widget-value widget))
           (internal (widget-apply old :value-to-internal external)))
      (widget-put old :value internal)))
    ;; Find new choice.
    (setq current
      (cond ((= (length args) 0)
         nil)
        ((= (length args) 1)
         (nth 0 args))
        ((and widget-choice-toggle
              (= (length args) 2)
              (memq old args))
         (if (eq old (nth 0 args))
             (nth 1 args)
           (nth 0 args)))
        (t
         (while args
           (setq current (car args)
             args (cdr args))
           (setq choices
             (cons (cons (widget-apply current :menu-tag-get)
                     current)
                   choices)))
         (widget-choose tag (reverse choices) event))))
    (when current
      (widget-value-set widget
            (widget-apply current :value-to-external
                      (widget-get current :value)))
      (widget-setup)
      (widget-apply widget :notify widget event)))
  (run-hook-with-args 'widget-edit-functions widget))

(defun widget-choice-validate (widget)
  ;; Valid if we have made a valid choice.
  (let ((void (widget-get widget :void))
    (choice (widget-get widget :choice))
    (child (car (widget-get widget :children))))
    (if (eq void choice)
    widget
      (widget-apply child :validate))))

(defun widget-choice-match (widget value)
  ;; Matches if one of the choices matches.
  (let ((args (widget-get widget :args))
    current found)
    (while (and args (not found))
      (setq current (car args)
        args (cdr args)
        found (widget-apply current :match value)))
    found))

(defun widget-choice-match-inline (widget values)
  ;; Matches if one of the choices matches.
  (let ((args (widget-get widget :args))
    current found)
    (while (and args (null found))
      (setq current (car args)
        args (cdr args)
        found (widget-match-inline current values)))
    found))

;;; The `toggle' Widget.

(define-widget 'toggle 'item
  "Toggle between two states."
  :format "%[%v%]\n"
  :value-create 'widget-toggle-value-create
  :action 'widget-toggle-action
  :match (lambda (widget value) t)
  :on "on"
  :off "off")

(defun widget-toggle-value-create (widget)
  ;; Insert text representing the `on' and `off' states.
  (if (widget-value widget)
      (widget-glyph-insert widget
               (widget-get widget :on)
               (widget-get widget :on-glyph))
      (widget-glyph-insert widget
               (widget-get widget :off)
               (widget-get widget :off-glyph))))

(defun widget-toggle-action (widget &optional event)
  ;; Toggle value.
  (widget-value-set widget (not (widget-value widget)))
  (widget-apply widget :notify widget event)
  (run-hook-with-args 'widget-edit-functions widget))

;;; The `checkbox' Widget.

(define-widget 'checkbox 'toggle
  "A checkbox toggle."
  :button-suffix ""
  :button-prefix ""
  :format "%[%v%]"
  :on "[X]"
  :on-glyph "check1"
  :off "[ ]"
  :off-glyph "check0"
  :action 'widget-checkbox-action)

(defun widget-checkbox-action (widget &optional event)
  "Toggle checkbox, notify parent, and set active state of sibling."
  (widget-toggle-action widget event)
  (let ((sibling (widget-get-sibling widget)))
    (when sibling
      (if (widget-value widget)
      (widget-apply sibling :activate)
    (widget-apply sibling :deactivate)))))

;;; The `checklist' Widget.

(define-widget 'checklist 'default
  "A multiple choice widget."
  :convert-widget 'widget-types-convert-widget
  :format "%v"
  :offset 4
  :entry-format "%b %v"
  :menu-tag "checklist"
  :greedy nil
  :value-create 'widget-checklist-value-create
  :value-delete 'widget-children-value-delete
  :value-get 'widget-checklist-value-get
  :validate 'widget-checklist-validate
  :match 'widget-checklist-match
  :match-inline 'widget-checklist-match-inline)

(defun widget-checklist-value-create (widget)
  ;; Insert all values
  (let ((alist (widget-checklist-match-find widget (widget-get widget :value)))
    (args (widget-get widget :args)))
    (while args
      (widget-checklist-add-item widget (car args) (assq (car args) alist))
      (setq args (cdr args)))
    (widget-put widget :children (nreverse (widget-get widget :children)))))

(defun widget-checklist-add-item (widget type chosen)
  ;; Create checklist item in WIDGET of type TYPE.
  ;; If the item is checked, CHOSEN is a cons whose cdr is the value.
  (and (eq (preceding-char) ?\n)
       (widget-get widget :indent)
       (insert-char ?\  (widget-get widget :indent)))
  (widget-specify-insert
   (let* ((children (widget-get widget :children))
      (buttons (widget-get widget :buttons))
      (button-args (or (widget-get type :sibling-args)
               (widget-get widget :button-args)))
      (from (point))
      child button)
     (insert (widget-get widget :entry-format))
     (goto-char from)
     ;; Parse % escapes in format.
     (while (re-search-forward "%\\([bv%]\\)" nil t)
       (let ((escape (aref (match-string 1) 0)))
     (replace-match "" t t)
     (cond ((eq escape ?%)
        (insert "%"))
           ((eq escape ?b)
        (setq button (apply 'widget-create-child-and-convert
                    widget 'checkbox
                    :value (not (null chosen))
                    button-args)))
           ((eq escape ?v)
        (setq child
              (cond ((not chosen)
                 (let ((child (widget-create-child widget type)))
                   (widget-apply child :deactivate)
                   child))
                ((widget-get type :inline)
                 (widget-create-child-value
                  widget type (cdr chosen)))
                (t
                 (widget-create-child-value
                  widget type (car (cdr chosen)))))))
           (t
        (error "Unknown escape `%c'" escape)))))
     ;; Update properties.
     (and button child (widget-put child :button button))
     (and button (widget-put widget :buttons (cons button buttons)))
     (and child (widget-put widget :children (cons child children))))))

(defun widget-checklist-match (widget values)
  ;; All values must match a type in the checklist.
  (and (listp values)
       (null (cdr (widget-checklist-match-inline widget values)))))

(defun widget-checklist-match-inline (widget values)
  ;; Find the values which match a type in the checklist.
  (let ((greedy (widget-get widget :greedy))
    (args (copy-sequence (widget-get widget :args)))
    found rest)
    (while values
      (let ((answer (widget-checklist-match-up args values)))
    (cond (answer
           (let ((vals (widget-match-inline answer values)))
         (setq found (append found (car vals))
               values (cdr vals)
               args (delq answer args))))
          (greedy
           (setq rest (append rest (list (car values)))
             values (cdr values)))
          (t
           (setq rest (append rest values)
             values nil)))))
    (cons found rest)))

(defun widget-checklist-match-find (widget vals)
  ;; Find the vals which match a type in the checklist.
  ;; Return an alist of (TYPE MATCH).
  (let ((greedy (widget-get widget :greedy))
    (args (copy-sequence (widget-get widget :args)))
    found)
    (while vals
      (let ((answer (widget-checklist-match-up args vals)))
    (cond (answer
           (let ((match (widget-match-inline answer vals)))
         (setq found (cons (cons answer (car match)) found)
               vals (cdr match)
               args (delq answer args))))
          (greedy
           (setq vals (cdr vals)))
          (t
           (setq vals nil)))))
    found))

(defun widget-checklist-match-up (args vals)
  ;; Rerturn the first type from ARGS that matches VALS.
  (let (current found)
    (while (and args (null found))
      (setq current (car args)
        args (cdr args)
        found (widget-match-inline current vals)))
    (if found
    current
      nil)))

(defun widget-checklist-value-get (widget)
  ;; The values of all selected items.
  (let ((children (widget-get widget :children))
    child result)
    (while children
      (setq child (car children)
        children (cdr children))
      (if (widget-value (widget-get child :button))
      (setq result (append result (widget-apply child :value-inline)))))
    result))

(defun widget-checklist-validate (widget)
  ;; Ticked chilren must be valid.
  (let ((children (widget-get widget :children))
    child button found)
    (while (and children (not found))
      (setq child (car children)
        children (cdr children)
        button (widget-get child :button)
        found (and (widget-value button)
               (widget-apply child :validate))))
    found))

;;; The `option' Widget

(define-widget 'option 'checklist
  "An widget with an optional item."
  :inline t)

;;; The `choice-item' Widget.

(define-widget 'choice-item 'item
  "Button items that delegate action events to their parents."
  :action 'widget-parent-action
  :format "%[%t%] \n")

;;; The `radio-button' Widget.

(define-widget 'radio-button 'toggle
  "A radio button for use in the `radio' widget."
  :notify 'widget-radio-button-notify
  :format "%[%v%]"
  :button-suffix ""
  :button-prefix ""
  :on "(*)"
  :on-glyph '("radio1" nil "radio0")
  :off "( )"
  :off-glyph "radio0")

(defun widget-radio-button-notify (widget child &optional event)
  ;; Tell daddy.
  (widget-apply (widget-get widget :parent) :action widget event))

;;; The `radio-button-choice' Widget.

(define-widget 'radio-button-choice 'default
  "Select one of multiple options."
  :convert-widget 'widget-types-convert-widget
  :offset 4
  :format "%v"
  :entry-format "%b %v"
  :menu-tag "radio"
  :value-create 'widget-radio-value-create
  :value-delete 'widget-children-value-delete
  :value-get 'widget-radio-value-get
  :value-inline 'widget-radio-value-inline
  :value-set 'widget-radio-value-set
  :error "You must push one of the buttons"
  :validate 'widget-radio-validate
  :match 'widget-choice-match
  :match-inline 'widget-choice-match-inline
  :action 'widget-radio-action)

(defun widget-radio-value-create (widget)
  ;; Insert all values
  (let ((args (widget-get widget :args))
    arg)
    (while args
      (setq arg (car args)
        args (cdr args))
      (widget-radio-add-item widget arg))))

(defun widget-radio-add-item (widget type)
  "Add to radio widget WIDGET a new radio button item of type TYPE."
  ;; (setq type (widget-convert type))
  (and (eq (preceding-char) ?\n)
       (widget-get widget :indent)
       (insert-char ?\  (widget-get widget :indent)))
  (widget-specify-insert
   (let* ((value (widget-get widget :value))
      (children (widget-get widget :children))
      (buttons (widget-get widget :buttons))
      (button-args (or (widget-get type :sibling-args)
               (widget-get widget :button-args)))
      (from (point))
      (chosen (and (null (widget-get widget :choice))
               (widget-apply type :match value)))
      child button)
     (insert (widget-get widget :entry-format))
     (goto-char from)
     ;; Parse % escapes in format.
     (while (re-search-forward "%\\([bv%]\\)" nil t)
       (let ((escape (aref (match-string 1) 0)))
     (replace-match "" t t)
     (cond ((eq escape ?%)
        (insert "%"))
           ((eq escape ?b)
        (setq button (apply 'widget-create-child-and-convert
                    widget 'radio-button
                    :value (not (null chosen))
                    button-args)))
           ((eq escape ?v)
        (setq child (if chosen
                (widget-create-child-value
                 widget type value)
                  (widget-create-child widget type)))
        (unless chosen
          (widget-apply child :deactivate)))
           (t
        (error "Unknown escape `%c'" escape)))))
     ;; Update properties.
     (when chosen
       (widget-put widget :choice type))
     (when button
       (widget-put child :button button)
       (widget-put widget :buttons (nconc buttons (list button))))
     (when child
       (widget-put widget :children (nconc children (list child))))
     child)))

(defun widget-radio-value-get (widget)
  ;; Get value of the child widget.
  (let ((chosen (widget-radio-chosen widget)))
    (and chosen (widget-value chosen))))

(defun widget-radio-chosen (widget)
  "Return the widget representing the chosen radio button."
  (let ((children (widget-get widget :children))
    current found)
    (while children
      (setq current (car children)
        children (cdr children))
      (let* ((button (widget-get current :button))
         (value (widget-apply button :value-get)))
    (when value
      (setq found current
        children nil))))
    found))

(defun widget-radio-value-inline (widget)
  ;; Get value of the child widget.
  (let ((children (widget-get widget :children))
    current found)
    (while children
      (setq current (car children)
        children (cdr children))
      (let* ((button (widget-get current :button))
         (value (widget-apply button :value-get)))
    (when value
      (setq found (widget-apply current :value-inline)
        children nil))))
    found))

(defun widget-radio-value-set (widget value)
  ;; We can't just delete and recreate a radio widget, since children
  ;; can be added after the original creation and won't be recreated
  ;; by `:create'.
  (let ((children (widget-get widget :children))
    current found)
    (while children
      (setq current (car children)
        children (cdr children))
      (let* ((button (widget-get current :button))
         (match (and (not found)
             (widget-apply current :match value))))
    (widget-value-set button match)
    (if match
        (progn
          (widget-value-set current value)
          (widget-apply current :activate))
      (widget-apply current :deactivate))
    (setq found (or found match))))))

(defun widget-radio-validate (widget)
  ;; Valid if we have made a valid choice.
  (let ((children (widget-get widget :children))
    current found button)
    (while (and children (not found))
      (setq current (car children)
        children (cdr children)
        button (widget-get current :button)
        found (widget-apply button :value-get)))
    (if found
    (widget-apply current :validate)
      widget)))

(defun widget-radio-action (widget child event)
  ;; Check if a radio button was pressed.
  (let ((children (widget-get widget :children))
    (buttons (widget-get widget :buttons))
    current)
    (when (memq child buttons)
      (while children
    (setq current (car children)
          children (cdr children))
    (let* ((button (widget-get current :button)))
      (cond ((eq child button)
         (widget-value-set button t)
         (widget-apply current :activate))
        ((widget-value button)
         (widget-value-set button nil)
         (widget-apply current :deactivate)))))))
  ;; Pass notification to parent.
  (widget-apply widget :notify child event))

;;; The `insert-button' Widget.

(define-widget 'insert-button 'push-button
  "An insert button for the `editable-list' widget."
  :tag "INS"
  :help-echo "Insert a new item into the list at this position"
  :action 'widget-insert-button-action)

(defun widget-insert-button-action (widget &optional event)
  ;; Ask the parent to insert a new item.
  (widget-apply (widget-get widget :parent)
        :insert-before (widget-get widget :widget)))

;;; The `delete-button' Widget.

(define-widget 'delete-button 'push-button
  "A delete button for the `editable-list' widget."
  :tag "DEL"
  :help-echo "Delete this item from the list"
  :action 'widget-delete-button-action)

(defun widget-delete-button-action (widget &optional event)
  ;; Ask the parent to insert a new item.
  (widget-apply (widget-get widget :parent)
        :delete-at (widget-get widget :widget)))

;;; The `editable-list' Widget.

(defcustom widget-editable-list-gui nil
  "If non nil, use GUI push-buttons in editable list when available."
  :type 'boolean
  :group 'widgets)

(define-widget 'editable-list 'default
  "A variable list of widgets of the same type."
  :convert-widget 'widget-types-convert-widget
  :offset 12
  :format "%v%i\n"
  :format-handler 'widget-editable-list-format-handler
  :entry-format "%i %d %v"
  :menu-tag "editable-list"
  :value-create 'widget-editable-list-value-create
  :value-delete 'widget-children-value-delete
  :value-get 'widget-editable-list-value-get
  :validate 'widget-children-validate
  :match 'widget-editable-list-match
  :match-inline 'widget-editable-list-match-inline
  :insert-before 'widget-editable-list-insert-before
  :delete-at 'widget-editable-list-delete-at)

(defun widget-editable-list-format-handler (widget escape)
  ;; We recognize the insert button.
  (let ((widget-push-button-gui widget-editable-list-gui))
    (cond ((eq escape ?i)
       (and (widget-get widget :indent)
        (insert-char ?\  (widget-get widget :indent)))
       (apply 'widget-create-child-and-convert
          widget 'insert-button
          (widget-get widget :append-button-args)))
      (t
       (widget-default-format-handler widget escape)))))

(defun widget-editable-list-value-create (widget)
  ;; Insert all values
  (let* ((value (widget-get widget :value))
     (type (nth 0 (widget-get widget :args)))
     (inlinep (widget-get type :inline))
     children)
    (widget-put widget :value-pos (copy-marker (point)))
    (set-marker-insertion-type (widget-get widget :value-pos) t)
    (while value
      (let ((answer (widget-match-inline type value)))
    (if answer
        (setq children (cons (widget-editable-list-entry-create
                  widget
                  (if inlinep
                      (car answer)
                    (car (car answer)))
                  t)
                 children)
          value (cdr answer))
      (setq value nil))))
    (widget-put widget :children (nreverse children))))

(defun widget-editable-list-value-get (widget)
  ;; Get value of the child widget.
  (apply 'append (mapcar (lambda (child) (widget-apply child :value-inline))
             (widget-get widget :children))))

(defun widget-editable-list-match (widget value)
  ;; Value must be a list and all the members must match the type.
  (and (listp value)
       (null (cdr (widget-editable-list-match-inline widget value)))))

(defun widget-editable-list-match-inline (widget value)
  (let ((type (nth 0 (widget-get widget :args)))
    (ok t)
    found)
    (while (and value ok)
      (let ((answer (widget-match-inline type value)))
    (if answer
        (setq found (append found (car answer))
          value (cdr answer))
      (setq ok nil))))
    (cons found value)))

(defun widget-editable-list-insert-before (widget before)
  ;; Insert a new child in the list of children.
  (save-excursion
    (let ((children (widget-get widget :children))
      (inhibit-read-only t)
      before-change-functions
      after-change-functions)
      (cond (before
         (goto-char (widget-get before :entry-from)))
        (t
         (goto-char (widget-get widget :value-pos))))
      (let ((child (widget-editable-list-entry-create
            widget nil nil)))
    (when (< (widget-get child :entry-from) (widget-get widget :from))
      (set-marker (widget-get widget :from)
              (widget-get child :entry-from)))
    (if (eq (car children) before)
        (widget-put widget :children (cons child children))
      (while (not (eq (car (cdr children)) before))
        (setq children (cdr children)))
      (setcdr children (cons child (cdr children)))))))
  (widget-setup)
  (widget-apply widget :notify widget))

(defun widget-editable-list-delete-at (widget child)
  ;; Delete child from list of children.
  (save-excursion
    (let ((buttons (copy-sequence (widget-get widget :buttons)))
      button
      (inhibit-read-only t)
      before-change-functions
      after-change-functions)
      (while buttons
    (setq button (car buttons)
          buttons (cdr buttons))
    (when (eq (widget-get button :widget) child)
      (widget-put widget
              :buttons (delq button (widget-get widget :buttons)))
      (widget-delete button))))
    (let ((entry-from (widget-get child :entry-from))
      (entry-to (widget-get child :entry-to))
      (inhibit-read-only t)
      before-change-functions
      after-change-functions)
      (widget-delete child)
      (delete-region entry-from entry-to)
      (set-marker entry-from nil)
      (set-marker entry-to nil))
    (widget-put widget :children (delq child (widget-get widget :children))))
  (widget-setup)
  (widget-apply widget :notify widget))

(defun widget-editable-list-entry-create (widget value conv)
  ;; Create a new entry to the list.
  (let ((type (nth 0 (widget-get widget :args)))
    (widget-push-button-gui widget-editable-list-gui)
    child delete insert)
    (widget-specify-insert
     (save-excursion
       (and (widget-get widget :indent)
        (insert-char ?\  (widget-get widget :indent)))
       (insert (widget-get widget :entry-format)))
     ;; Parse % escapes in format.
     (while (re-search-forward "%\\(.\\)" nil t)
       (let ((escape (aref (match-string 1) 0)))
     (replace-match "" t t)
     (cond ((eq escape ?%)
        (insert "%"))
           ((eq escape ?i)
        (setq insert (apply 'widget-create-child-and-convert
                    widget 'insert-button
                    (widget-get widget :insert-button-args))))
           ((eq escape ?d)
        (setq delete (apply 'widget-create-child-and-convert
                    widget 'delete-button
                    (widget-get widget :delete-button-args))))
           ((eq escape ?v)
        (if conv
            (setq child (widget-create-child-value
                 widget type value))
          (setq child (widget-create-child widget type))))
           (t
        (error "Unknown escape `%c'" escape)))))
     (widget-put widget
         :buttons (cons delete
                (cons insert
                      (widget-get widget :buttons))))
     (let ((entry-from (copy-marker (point-min)))
       (entry-to (copy-marker (point-max))))
       (set-marker-insertion-type entry-from t)
       (set-marker-insertion-type entry-to nil)
       (widget-put child :entry-from entry-from)
       (widget-put child :entry-to entry-to)))
    (widget-put insert :widget child)
    (widget-put delete :widget child)
    child))

;;; The `group' Widget.

(define-widget 'group 'default
  "A widget which group other widgets inside."
  :convert-widget 'widget-types-convert-widget
  :format "%v"
  :value-create 'widget-group-value-create
  :value-delete 'widget-children-value-delete
  :value-get 'widget-editable-list-value-get
  :validate 'widget-children-validate
  :match 'widget-group-match
  :match-inline 'widget-group-match-inline)

(defun widget-group-value-create (widget)
  ;; Create each component.
  (let ((args (widget-get widget :args))
    (value (widget-get widget :value))
    arg answer children)
    (while args
      (setq arg (car args)
        args (cdr args)
        answer (widget-match-inline arg value)
        value (cdr answer))
      (and (eq (preceding-char) ?\n)
       (widget-get widget :indent)
       (insert-char ?\  (widget-get widget :indent)))
      (push (cond ((null answer)
           (widget-create-child widget arg))
          ((widget-get arg :inline)
           (widget-create-child-value widget arg  (car answer)))
          (t
           (widget-create-child-value widget arg  (car (car answer)))))
        children))
    (widget-put widget :children (nreverse children))))

(defun widget-group-match (widget values)
  ;; Match if the components match.
  (and (listp values)
       (let ((match (widget-group-match-inline widget values)))
     (and match (null (cdr match))))))

(defun widget-group-match-inline (widget vals)
  ;; Match if the components match.
  (let ((args (widget-get widget :args))
    argument answer found)
    (while args
      (setq argument (car args)
        args (cdr args)
        answer (widget-match-inline argument vals))
      (if answer
      (setq vals (cdr answer)
        found (append found (car answer)))
    (setq vals nil
          args nil)))
    (if answer
    (cons found vals)
      nil)))

;;; The `visibility' Widget.

(define-widget 'visibility 'item
  "An indicator and manipulator for hidden items."
  :format "%[%v%]"
  :button-prefix ""
  :button-suffix ""
  :on "Hide"
  :off "Show"
  :value-create 'widget-visibility-value-create
  :action 'widget-toggle-action
  :match (lambda (widget value) t))

(defun widget-visibility-value-create (widget)
  ;; Insert text representing the `on' and `off' states.
  (let ((on (widget-get widget :on))
    (off (widget-get widget :off)))
    (if on
    (setq on (concat widget-push-button-prefix
             on
             widget-push-button-suffix))
      (setq on ""))
    (if off
    (setq off (concat widget-push-button-prefix
              off
              widget-push-button-suffix))
      (setq off ""))
    (if (widget-value widget)
    (widget-glyph-insert widget on '("down" "down-pushed"))
      (widget-glyph-insert widget off '("right" "right-pushed")))))

;;; The `documentation-link' Widget.
;;
;; This is a helper widget for `documentation-string'.

(define-widget 'documentation-link 'link
  "Link type used in documentation strings."
  :tab-order -1
  :help-echo 'widget-documentation-link-echo-help
  :action 'widget-documentation-link-action)

(defun widget-documentation-link-echo-help (widget)
  "Tell what this link will describe."
  (concat "Describe the `" (widget-get widget :value) "' symbol."))

(defun widget-documentation-link-action (widget &optional event)
  "Display documentation for WIDGET's value.  Ignore optional argument EVENT."
  (let* ((string (widget-get widget :value))
     (symbol (intern string)))
    (if (and (fboundp symbol) (boundp symbol))
    ;; If there are two doc strings, give the user a way to pick one.
    (apropos (concat "\\`" (regexp-quote string) "\\'"))
      (if (fboundp symbol)
      (describe-function symbol)
    (describe-variable symbol)))))

(defcustom widget-documentation-links t
  "Add hyperlinks to documentation strings when non-nil."
  :type 'boolean
  :group 'widget-documentation)

(defcustom widget-documentation-link-regexp "`\\([^\n`' ]+\\)'"
  "Regexp for matching potential links in documentation strings.
The first group should be the link itself."
  :type 'regexp
  :group 'widget-documentation)

(defcustom widget-documentation-link-p 'intern-soft
  "Predicate used to test if a string is useful as a link.
The value should be a function.  The function will be called one
argument, a string, and should return non-nil if there should be a
link for that string."
  :type 'function
  :options '(widget-documentation-link-p)
  :group 'widget-documentation)

(defcustom widget-documentation-link-type 'documentation-link
  "Widget type used for links in documentation strings."
  :type 'symbol
  :group 'widget-documentation)

(defun widget-documentation-link-add (widget from to)
  (widget-specify-doc widget from to)
  (when widget-documentation-links
    (let ((regexp widget-documentation-link-regexp)
      (predicate widget-documentation-link-p)
      (type widget-documentation-link-type)
      (buttons (widget-get widget :buttons)))
      (save-excursion
    (goto-char from)
    (while (re-search-forward regexp to t)
      (let ((name (match-string 1))
        (begin (match-beginning 1))
        (end (match-end 1)))
        (when (funcall predicate name)
          (push (widget-convert-button type begin end :value name)
            buttons)))))
      (widget-put widget :buttons buttons)))
  (let ((indent (widget-get widget :indent)))
    (when (and indent (not (zerop indent)))
      (save-excursion
    (save-restriction
      (narrow-to-region from to)
      (goto-char (point-min))
      (while (search-forward "\n" nil t)
        (insert-char ?\  indent)))))))

;;; The `documentation-string' Widget.

(define-widget 'documentation-string 'item
  "A documentation string."
  :format "%v"
  :action 'widget-documentation-string-action
  :value-delete 'widget-children-value-delete
  :value-create 'widget-documentation-string-value-create)

(defun widget-documentation-string-value-create (widget)
  ;; Insert documentation string.
  (let ((doc (widget-value widget))
    (indent (widget-get widget :indent))
    (shown (widget-get (widget-get widget :parent) :documentation-shown))
    (start (point)))
    (if (string-match "\n" doc)
    (let ((before (substring doc 0 (match-beginning 0)))
          (after (substring doc (match-beginning 0)))
          buttons)
      (insert before " ")
      (widget-documentation-link-add widget start (point))
      (push (widget-create-child-and-convert
         widget 'visibility
         :help-echo (lambda (widget)
                  (concat
                   (if (widget-value widget)
                   "Hide" "Show")
                   " the rest of the documentation"))
         :off "More"
         :action 'widget-parent-action
         shown)
        buttons)
      (when shown
        (setq start (point))
        (when indent
          (insert-char ?\  indent))
        (insert after)
        (widget-documentation-link-add widget start (point)))
      (widget-put widget :buttons buttons))
      (insert doc)
      (widget-documentation-link-add widget start (point))))
  (insert "\n"))

(defun widget-documentation-string-action (widget &rest ignore)
  ;; Toggle documentation.
  (let ((parent (widget-get widget :parent)))
    (widget-put parent :documentation-shown
        (not (widget-get parent :documentation-shown))))
  ;; Redraw.
  (widget-value-set widget (widget-value widget)))

;;; The Sexp Widgets.

(define-widget 'const 'item
  "An immutable sexp."
  :prompt-value 'widget-const-prompt-value
  :format "%t\n%d")

(defun widget-const-prompt-value (widget prompt value unbound)
  ;; Return the value of the const.
  (widget-value widget))

(define-widget 'function-item 'const
  "An immutable function name."
  :format "%v\n%h"
  :documentation-property (lambda (symbol)
                (condition-case nil
                (documentation symbol t)
                  (error nil))))

(define-widget 'variable-item 'const
  "An immutable variable name."
  :format "%v\n%h"
  :documentation-property 'variable-documentation)

(defvar widget-string-prompt-value-history nil
  "History of input to `widget-string-prompt-value'.")

(define-widget 'string 'editable-field
  "A string"
  :tag "String"
  :format "%{%t%}: %v"
  :complete-function 'ispell-complete-word
  :prompt-history 'widget-string-prompt-value-history)

(define-widget 'regexp 'string
  "A regular expression."
  :match 'widget-regexp-match
  :validate 'widget-regexp-validate
  ;; Doesn't work well with terminating newline.
  ;; :value-face 'widget-single-line-field-face
  :tag "Regexp")

(defun widget-regexp-match (widget value)
  ;; Match valid regexps.
  (and (stringp value)
       (condition-case nil
       (prog1 t
         (string-match value ""))
     (error nil))))

(defun widget-regexp-validate (widget)
  "Check that the value of WIDGET is a valid regexp."
  (let ((value (widget-value widget)))
    (condition-case data
    (prog1 nil
      (string-match value ""))
      (error (widget-put widget :error (error-message-string data))
         widget))))

(define-widget 'file 'string
  "A file widget.
It will read a file name from the minibuffer when invoked."
  :complete-function 'widget-file-complete
  :prompt-value 'widget-file-prompt-value
  :format "%{%t%}: %v"
  ;; Doesn't work well with terminating newline.
  ;; :value-face 'widget-single-line-field-face
  :tag "File")

(defun widget-file-complete ()
  "Perform completion on file name preceding point."
  (interactive)
  (let* ((end (point))
     (beg (save-excursion
        (skip-chars-backward "^ ")
        (point)))
     (pattern (buffer-substring beg end))
     (name-part (file-name-nondirectory pattern))
     (directory (file-name-directory pattern))
     (completion (file-name-completion name-part directory)))
    (cond ((eq completion t))
      ((null completion)
       (message "Can't find completion for \"%s\"" pattern)
       (ding))
      ((not (string= name-part completion))
       (delete-region beg end)
       (insert (expand-file-name completion directory)))
      (t
       (message "Making completion list...")
       (let ((list (file-name-all-completions name-part directory)))
         (setq list (sort list 'string<))
         (with-output-to-temp-buffer "*Completions*"
           (display-completion-list list)))
       (message "Making completion list...%s" "done")))))

(defun widget-file-prompt-value (widget prompt value unbound)
  ;; Read file from minibuffer.
  (abbreviate-file-name
   (if unbound
       (read-file-name prompt)
     (let ((prompt2 (format "%s (default %s) " prompt value))
       (dir (file-name-directory value))
       (file (file-name-nondirectory value))
       (must-match (widget-get widget :must-match)))
       (read-file-name prompt2 dir nil must-match file)))))

;;;(defun widget-file-action (widget &optional event)
;;;  ;; Read a file name from the minibuffer.
;;;  (let* ((value (widget-value widget))
;;;     (dir (file-name-directory value))
;;;     (file (file-name-nondirectory value))
;;;     (menu-tag (widget-apply widget :menu-tag-get))
;;;     (must-match (widget-get widget :must-match))
;;;     (answer (read-file-name (concat menu-tag ": (default `" value "') ")
;;;                 dir nil must-match file)))
;;;    (widget-value-set widget (abbreviate-file-name answer))
;;;    (widget-setup)
;;;    (widget-apply widget :notify widget event)))

(define-widget 'directory 'file
  "A directory widget.
It will read a directory name from the minibuffer when invoked."
  :tag "Directory")

(defvar widget-symbol-prompt-value-history nil
  "History of input to `widget-symbol-prompt-value'.")

(define-widget 'symbol 'editable-field
  "A lisp symbol."
  :value nil
  :tag "Symbol"
  :format "%{%t%}: %v"
  :match (lambda (widget value) (symbolp value))
  :complete-function 'lisp-complete-symbol
  :prompt-internal 'widget-symbol-prompt-internal
  :prompt-match 'symbolp
  :prompt-history 'widget-symbol-prompt-value-history
  :value-to-internal (lambda (widget value)
               (if (symbolp value)
               (symbol-name value)
             value))
  :value-to-external (lambda (widget value)
               (if (stringp value)
               (intern value)
             value)))

(defun widget-symbol-prompt-internal (widget prompt initial history)
  ;; Read file from minibuffer.
  (let ((answer (completing-read prompt obarray
                 (widget-get widget :prompt-match)
                 nil initial history)))
    (if (and (stringp answer)
         (not (zerop (length answer))))
    answer
      (error "No value"))))

(defvar widget-function-prompt-value-history nil
  "History of input to `widget-function-prompt-value'.")

(define-widget 'function 'sexp
  "A lisp function."
  :complete-function 'lisp-complete-symbol
  :prompt-value 'widget-field-prompt-value
  :prompt-internal 'widget-symbol-prompt-internal
  :prompt-match 'fboundp
  :prompt-history 'widget-function-prompt-value-history
  :action 'widget-field-action
  :tag "Function")

(defvar widget-variable-prompt-value-history nil
  "History of input to `widget-variable-prompt-value'.")

(define-widget 'variable 'symbol
  ;; Should complete on variables.
  "A lisp variable."
  :prompt-match 'boundp
  :prompt-history 'widget-variable-prompt-value-history
  :tag "Variable")

;; This part issues a warning when compiling without Mule.  Is there a
;; way of shutting it up?
;;
;; OK, I'll simply comment the whole thing out, until someone decides
;; to do something with it.
;(defvar widget-coding-system-prompt-value-history nil
;  "History of input to `widget-coding-system-prompt-value'.")

;(define-widget 'coding-system 'symbol
;  "A MULE coding-system."
;  :format "%{%t%}: %v"
;  :tag "Coding system"
;  :prompt-history 'widget-coding-system-prompt-value-history
;  :prompt-value 'widget-coding-system-prompt-value
;  :action 'widget-coding-system-action)

;(defun widget-coding-system-prompt-value (widget prompt value unbound)
;  ;; Read coding-system from minibuffer.
;  (intern
;   (completing-read (format "%s (default %s) " prompt value)
;            (mapcar (lambda (sym)
;                  (list (symbol-name sym)))
;                (coding-system-list)))))

;(defun widget-coding-system-action (widget &optional event)
;  ;; Read a file name from the minibuffer.
;  (let ((answer
;     (widget-coding-system-prompt-value
;      widget
;      (widget-apply widget :menu-tag-get)
;      (widget-value widget)
;      t)))
;    (widget-value-set widget answer)
;    (widget-apply widget :notify widget event)
;    (widget-setup)))

(define-widget 'sexp 'editable-field
  "An arbitrary lisp expression."
  :tag "Lisp expression"
  :format "%{%t%}: %v"
  :value nil
  :validate 'widget-sexp-validate
  :match (lambda (widget value) t)
  :value-to-internal 'widget-sexp-value-to-internal
  :value-to-external (lambda (widget value) (read value))
  :prompt-history 'widget-sexp-prompt-value-history
  :prompt-value 'widget-sexp-prompt-value)

(defun widget-sexp-value-to-internal (widget value)
  ;; Use pp for printer representation.
  (let ((pp (if (symbolp value)
        (prin1-to-string value)
          (pp-to-string value))))
    (while (string-match "\n\\'" pp)
      (setq pp (substring pp 0 -1)))
    (if (or (string-match "\n\\'" pp)
        (> (length pp) 40))
    (concat "\n" pp)
      pp)))

(defun widget-sexp-validate (widget)
  ;; Valid if we can read the string and there is no junk left after it.
  (save-excursion
    (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
      (erase-buffer)
      (insert (widget-apply widget :value-get))
      (goto-char (point-min))
      (condition-case data
      (let ((value (read buffer)))
        (if (eobp)
        (if (widget-apply widget :match value)
            nil
          (widget-put widget :error (widget-get widget :type-error))
          widget)
          (widget-put widget
              :error (format "Junk at end of expression: %s"
                     (buffer-substring (point)
                               (point-max))))
          widget))
    (error (widget-put widget :error (error-message-string data))
           widget)))))

(defvar widget-sexp-prompt-value-history nil
  "History of input to `widget-sexp-prompt-value'.")

(defun widget-sexp-prompt-value (widget prompt value unbound)
  ;; Read an arbitrary sexp.
  (let ((found (read-string prompt
                (if unbound nil (cons (prin1-to-string value) 0))
                (widget-get widget :prompt-history))))
    (save-excursion
      (let ((buffer (set-buffer (get-buffer-create " *Widget Scratch*"))))
    (erase-buffer)
    (insert found)
    (goto-char (point-min))
    (let ((answer (read buffer)))
      (unless (eobp)
        (error "Junk at end of expression: %s"
           (buffer-substring (point) (point-max))))
      answer)))))

(define-widget 'restricted-sexp 'sexp
  "A Lisp expression restricted to values that match.
To use this type, you must define :match or :match-alternatives."
  :type-error "The specified value is not valid"
  :match 'widget-restricted-sexp-match
  :value-to-internal (lambda (widget value)
               (if (widget-apply widget :match value)
               (prin1-to-string value)
             value)))

(defun widget-restricted-sexp-match (widget value)
  (let ((alternatives (widget-get widget :match-alternatives))
    matched)
    (while (and alternatives (not matched))
      (if (cond ((functionp (car alternatives))
         (funcall (car alternatives) value))
        ((and (consp (car alternatives))
              (eq (car (car alternatives)) 'quote))
         (eq value (nth 1 (car alternatives)))))
      (setq matched t))
      (setq alternatives (cdr alternatives)))
    matched))

(define-widget 'integer 'restricted-sexp
  "An integer."
  :tag "Integer"
  :value 0
  :type-error "This field should contain an integer"
  :match-alternatives '(integerp))

(define-widget 'number 'restricted-sexp
  "A floating point number."
  :tag "Number"
  :value 0.0
  :type-error "This field should contain a number"
  :match-alternatives '(numberp))

(define-widget 'character 'editable-field
  "A character."
  :tag "Character"
  :value ?\0
  :format "%{%t%}: %v"
  :valid-regexp "\\`[\0-\377]\\'"
  :error "This field should contain a single character"
  :value-to-internal (lambda (widget value)
               (if (stringp value)
               value
             (char-to-string value)))
  :value-to-external (lambda (widget value)
               (if (stringp value)
               (aref value 0)
             value))
  :match (lambda (widget value)
       (characterp value)))

(define-widget 'list 'group
  "A lisp list."
  :tag "List"
  :format "%{%t%}:\n%v")

(define-widget 'vector 'group
  "A lisp vector."
  :tag "Vector"
  :format "%{%t%}:\n%v"
  :match 'widget-vector-match
  :value-to-internal (lambda (widget value) (append value nil))
  :value-to-external (lambda (widget value) (vconcat value)))

(defun widget-vector-match (widget value)
  (and (vectorp value)
       (widget-group-match widget
               (widget-apply widget :value-to-internal value))))

(define-widget 'cons 'group
  "A cons-cell."
  :tag "Cons-cell"
  :format "%{%t%}:\n%v"
  :match 'widget-cons-match
  :value-to-internal (lambda (widget value)
               (list (car value) (cdr value)))
  :value-to-external (lambda (widget value)
               (cons (car value) (cadr value))))

(defun widget-cons-match (widget value)
  (and (consp value)
       (widget-group-match widget
               (widget-apply widget :value-to-internal value))))

(define-widget 'choice 'menu-choice
  "A union of several sexp types."
  :tag "Choice"
  :format "%{%t%}: %[Value Menu%] %v"
  :button-prefix 'widget-push-button-prefix
  :button-suffix 'widget-push-button-suffix
  :prompt-value 'widget-choice-prompt-value)

(defun widget-choice-prompt-value (widget prompt value unbound)
  "Make a choice."
  (let ((args (widget-get widget :args))
    (completion-ignore-case (widget-get widget :case-fold))
    current choices old)
    ;; Find the first arg that match VALUE.
    (let ((look args))
      (while look
    (if (widget-apply (car look) :match value)
        (setq old (car look)
          look nil)
      (setq look (cdr look)))))
    ;; Find new choice.
    (setq current
      (cond ((= (length args) 0)
         nil)
        ((= (length args) 1)
         (nth 0 args))
        ((and (= (length args) 2)
              (memq old args))
         (if (eq old (nth 0 args))
             (nth 1 args)
           (nth 0 args)))
        (t
         (while args
           (setq current (car args)
             args (cdr args))
           (setq choices
             (cons (cons (widget-apply current :menu-tag-get)
                     current)
                   choices)))
         (let ((val (completing-read prompt choices nil t)))
           (if (stringp val)
               (let ((try (try-completion val choices)))
             (when (stringp try)
               (setq val try))
             (cdr (assoc val choices)))
             nil)))))
    (if current
    (widget-prompt-value current prompt nil t)
      value)))

(define-widget 'radio 'radio-button-choice
  "A union of several sexp types."
  :tag "Choice"
  :format "%{%t%}:\n%v"
  :prompt-value 'widget-choice-prompt-value)

(define-widget 'repeat 'editable-list
  "A variable length homogeneous list."
  :tag "Repeat"
  :format "%{%t%}:\n%v%i\n")

(define-widget 'set 'checklist
  "A list of members from a fixed set."
  :tag "Set"
  :format "%{%t%}:\n%v")

(define-widget 'boolean 'toggle
  "To be nil or non-nil, that is the question."
  :tag "Boolean"
  :prompt-value 'widget-boolean-prompt-value
  :button-prefix 'widget-push-button-prefix
  :button-suffix 'widget-push-button-suffix
  :format "%{%t%}: %[Toggle%]  %v\n"
  :on "on (non-nil)"
  :off "off (nil)")

(defun widget-boolean-prompt-value (widget prompt value unbound)
  ;; Toggle a boolean.
  (y-or-n-p prompt))

;;; The `color' Widget.

(define-widget 'color 'editable-field
  "Choose a color name (with sample)."
  :format "%[%t%]: %v (%{sample%})\n"
  :size 10
  :tag "Color"
  :value "black"
  :complete 'widget-color-complete
  :sample-face-get 'widget-color-sample-face-get
  :notify 'widget-color-notify
  :action 'widget-color-action)

(defun widget-color-complete (widget)
  "Complete the color in WIDGET."
  (let* ((prefix (buffer-substring-no-properties (widget-field-start widget)
                         (point)))
     (list (widget-color-choice-list))
     (completion (try-completion prefix list)))
    (cond ((eq completion t)
       (message "Exact match"))
      ((null completion)
       (error "Can't find completion for \"%s\"" prefix))
      ((not (string-equal prefix completion))
       (insert (substring completion (length prefix))))
      (t
       (message "Making completion list...")
       (let ((list (all-completions prefix list nil)))
         (with-output-to-temp-buffer "*Completions*"
           (display-completion-list list)))
       (message "Making completion list...done")))))

(defun widget-color-sample-face-get (widget)
  (or (widget-get widget :sample-face)
      (let ((color (widget-value widget))
        (face (make-face (gensym "sample-face-") nil t)))
    ;; Use the face object, not its name, to prevent lossage if gc
    ;; happens before applying the face.
    (widget-put widget :sample-face face)
    (and color
         (not (equal color ""))
         (valid-color-name-p color)
         (set-face-foreground face color))
    face)))

(defvar widget-color-choice-list nil)
;; Variable holding the possible colors.

(defun widget-color-choice-list ()
  (or widget-color-choice-list
      (setq widget-color-choice-list (read-color-completion-table))))

(defvar widget-color-history nil
  "History of entered colors")

(defun widget-color-action (widget &optional event)
  ;; Prompt for a color.
  (let* ((tag (widget-apply widget :menu-tag-get))
     (answer (read-color (concat tag ": "))))
    (unless (zerop (length answer))
      (widget-value-set widget answer)
      (widget-setup)
      (widget-apply widget :notify widget event))))

(defun widget-color-notify (widget child &optional event)
  "Update the sample, and notify the parent."
  (let* ((face (widget-apply widget :sample-face-get))
     (color (widget-value widget)))
    (if (valid-color-name-p color)
    (set-face-foreground face color)
      (remove-face-property face 'foreground)))
  (widget-default-notify widget child event))

;; Is this a misnomer?
(defun widget-at (pos)
  "The button or field at POS."
  (or (get-char-property pos 'button)
      (get-char-property pos 'field)))

(defun widget-echo-help (pos)
  "Display the help echo for widget at POS."
  (let* ((widget (widget-at pos))
     (help-echo (and widget (widget-get widget :help-echo))))
    (and (functionp help-echo)
     (setq help-echo (funcall help-echo widget)))
    (when (stringp help-echo)
      (display-message 'help-echo help-echo))))

;;; The End:

(provide 'wid-edit)

;; wid-edit.el ends here